diff --git a/idMatchApi.yml b/idMatchApi.yml index 0970c88..5b2ffbf 100644 --- a/idMatchApi.yml +++ b/idMatchApi.yml @@ -3,61 +3,39 @@ info: version: 1.1.0 title: ID Match API description: ID Match API Specification from Internet2 Trust and Identity, and Spherical Cow Group + security: - accessCode: - read - write servers: - - description: SwaggerHub API Auto Mocking - url: https://virtserver.swaggerhub.com/I2/idMatch/1.0.0 + - url: https://virtserver.swaggerhub.com/I2/idMatch/v1 + description: "SwaggerHub API Auto Mocking" paths: - /sis: - - get: - description: Returns a list of people - parameters: - - $ref: '#/components/parameters/PageLimit' - - $ref: '#/components/parameters/PageOffset' - responses: - '200': - description: Successfully returned a list of people - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/person' - '400': - $ref: '#/components/responses/400Error' - - post: - description: Get a reference ID for an SoR person - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/person' - responses: - '200': - description: Found (or added) person record - '400': - $ref: '#/components/responses/400Error' - - /sis/{sorId}: - get: - description: Obtain information about an person from his or her sorId + /person/{sorLabel}/{sorId}: + put: + tags: + - idMatch + summary: Request a Reference Identifier for an SOR Person + operationId: "request" parameters: - - name: sorId - in: path - required: true - schema: - type: string + - name: sorLabel + in: path + description: The official designation of the requesting SOR + required: true + schema: + type: string + - name: sorId + in: path + description: The SOR-assigned identifier for the person + required: true + schema: + type: string responses: - '200': - description: Successfully returned the requested person record + '201': + description: Return new referenceId for a person new to ID Match content: application/json: schema: @@ -85,8 +63,8 @@ paths: get: summary: Server heartbeat operation description: >- - This operation shows how to override the global security defined above, - as we want to open it up for all users. + This operation shows how to override the global security defined + above as we want to open it up for all users. security: [] responses: '200':