Function onEndpoint

packages/platform/src/OpenApi.ts:321–437

({ endpoint, errors, group, mergedAnnotations, middleware, payloads, successes })

      spec.tags.push(tag)
    },
    onEndpoint({ endpoint, errors, group, mergedAnnotations, middleware, payloads, successes }) {
      if (Context.get(mergedAnnotations, Exclude)) {
        return
      }
      let op: OpenAPISpecOperation = {
        tags: [Context.getOrElse(group.annotations, Title, () => group.identifier)],
        operationId: Context.getOrElse(
          endpoint.annotations,
          Identifier,
          () => group.topLevel ? endpoint.name : `${group.identifier}.${endpoint.name}`
        ),
        parameters: [],
        security: [],
        responses: {}
      }

      function processResponseMap(
        map: ReadonlyMap<number, {
          readonly ast: Option.Option<AST.AST>
          readonly description: Option.Option<string>
        }>,
        defaultDescription: () => string
      ) {
        for (const [status, { ast, description }] of map) {
          if (op.responses[status]) continue
          op.responses[status] = {
            description: Option.getOrElse(description, defaultDescription)
          }
          ast.pipe(
            Option.filter((ast) => !HttpApiSchema.getEmptyDecodeable(ast)),
            Option.map((ast) => {
              const encoding = HttpApiSchema.getEncoding(ast)
              op.responses[status].content = {
                [encoding.contentType]: {
                  schema: processAST(ast)
                }
              }
            })
          )
        }
      }

      function processParameters(schema: Option.Option<Schema.Schema.All>, i: OpenAPISpecParameter["in"]) {
        if (Option.isSome(schema)) {
          const jsonSchema = processAST(schema.value.ast)
          if ("properties" in jsonSchema) {
            Object.entries(jsonSchema.properties).forEach(([name, psJsonSchema]) => {
              op.parameters.push({
                name,
                in: i,
                schema: psJsonSchema,
                required: jsonSchema.required.includes(name),
                ...(psJsonSchema.description !== undefined ? { description: psJsonSchema.description } : undefined)
              })
            })
          }
        }
      }