swagger.yml

swagger: '2.0'

info:
  version: "1.0-SNAPSHOT"
  title: "__API_NAME__"
  description: |
    個人に紐づけられた最新の情報を管理します。

    プロフィールに対する閲覧アクセスは、テナントのドメインが特定可能である必要があります。
    API サーバは、 IP アドレスもしくは認証によってドメインを特定します。

schemes:
  - 'https'
x-amazon-apigateway-request-validators:
  all:
    validateRequestBody: true
    validateRequestParameters: true
  params-only:
    validateRequestBody: false
    validateRequestParameters: true

securityDefinitions:
  CustomAuthorizer:
    type: apiKey
    name: Authorization
    in: header
    x-amazon-apigateway-authtype: oauth2
    x-amazon-apigateway-authorizer:
      authorizerResultTtlInSeconds: 0
      authorizerUri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_authorizer/invocations"
      # authorizerCredentials: arn:aws:iam::__ACCOUNT_ID__:role
      type: token

paths:
  /sustain:
    get:
      description: |
        アカウントサービス移行用の一時リソース。
      parameters:
        - "$ref": "#/parameters/Authorization"
      responses:
        200:
          description: "トークンをリフレッシュ"
          schema:
            type: object
            properties:
              token:
                type: string
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_sustain/invocations"
        type: aws_proxy
    options:
      consumes:
        - application/json
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              type: string
            Access-Control-Allow-Methods:
              type: string
            Access-Control-Allow-Credentials:
              type: string
            Access-Control-Allow-Headers:
              type: string
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: '200'
            responseParameters:
              method.response.header.Access-Control-Allow-Credentials: "'true'"
              method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,Pragma,Cache-Control,If-Modified-Since'"
              method.response.header.Access-Control-Allow-Origin: "'__ACCESS_CONTROL_ALLOW_ORIGIN__'"
        requestTemplates:
          application/json: '{"statusCode": 200}'
        passthroughBehavior: when_no_match
        type: mock
  /profiles:
    get:
      description: |
        個人情報の一覧を取得します。

        クエリパラメータによって絞り込みを行うことができます。
        `q` による検索は、スペース区切りで複数のキーワードを指定できます。
      parameters:
        - "$ref": "#/parameters/Authorization_opt"
        - "$ref": "#/parameters/X-Forwarded-For"
        - name: q
          description: |
            検索に利用するクエリ文字列です（1000文字以内）。

            `userId`, `employeeId` と同時には使用できません。
          in: query
          type: string
        - name: userId
          description: |
            ログインアカウントの User ID によって絞り込みます。
            複数の場合は、 `,` で区切って指定します。

            `q`, `employeeId` と同時には使用できません。
          in: query
          type: string
        - name: employeeId
          description: |
            組織内で利用される社員番号などで絞り込みます。
            複数の場合は、 `,` で区切って指定します。

            `q`, `userId` と同時には使用できません。
          in: query
          type: string
        - name: limit
          description: |
            検索結果の最大件数を指定します。
            最大（＝デフォルト）値は 100 です。
          in: query
          type: integer
          default: 100
          minimum: 1
          maximum: 100
        - name: exclusiveStartKey
          description: |
            前回の `lastEvaluatedKey` を付与し、ページネーションを行います。
            このキーのデータ以降で、このキーを除くデータが返されます。
          in: query
          type: string
        - name: order
          description: |
            検索結果の順序を指定します。
            指定可能な項目は以下です。

            * `employeeId`
            * `name`

            `-employeeId` のように `-` をつけると降順になります。

            指定しない場合は `order=employeeId` と同じです。
          in: query
          type: string
          enum:
            - "employeeId"
            - "name"
            - "-employeeId"
            - "-name"
          default: employeeId
      responses:
        200:
          description: プロフィールの検索結果を返します。
          schema:
            type: object
            properties:
              profiles:
                type: array
                items:
                  $ref: "#/definitions/Profile"
              lastEvaluatedKey:
                type: string
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: params-only
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_profiles_query/invocations"
        type: aws_proxy
    options:
      consumes:
        - application/json
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              type: string
            Access-Control-Allow-Methods:
              type: string
            Access-Control-Allow-Credentials:
              type: string
            Access-Control-Allow-Headers:
              type: string
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: '200'
            responseParameters:
              method.response.header.Access-Control-Allow-Credentials: "'true'"
              method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,Pragma,Cache-Control,If-Modified-Since'"
              method.response.header.Access-Control-Allow-Origin: "'__ACCESS_CONTROL_ALLOW_ORIGIN__'"
        requestTemplates:
          application/json: '{"statusCode": 200}'
        passthroughBehavior: when_no_match
        type: mock

  /profiles/{userId}:
    get:
      description: プロフィールを取得します。
      parameters:
        - name: userId
          description: ""
          in: path
          type: string
          required: true
        - "$ref": "#/parameters/Authorization_opt"
        - "$ref": "#/parameters/X-Forwarded-For"
      responses:
        200:
          description: ""
          schema:
            $ref: "#/definitions/Profile"
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        404:
          description: |
            Not Found

            たとえ他のドメインに存在していても、サーバは 404 によってその存在を隠す必要があります。
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: params-only
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_profiles_get/invocations"
        type: aws_proxy

    put:
      description: |
        個人情報を登録・更新します。
      parameters:
        - "$ref": "#/parameters/Authorization"
        - name: userId
          description: ""
          in: path
          type: string
          required: true
        - name: body
          in: body
          schema:
            $ref: "#/definitions/Profile"
          required: true
      responses:
        200:
          description: ""
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: all
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_profiles_put/invocations"
        type: aws_proxy

    patch:
      description: |
        個人情報を編集します。

        PUT は指定していない項目が削除されますが、 PATCH 指定していない項目を変更しません。
        明示的に削除するには、空文字を設定します。
      parameters:
        - "$ref": "#/parameters/Authorization"
        - name: userId
          description: ""
          in: path
          type: string
          required: true
        - name: body
          in: body
          schema:
            $ref: "#/definitions/Profile"
          required: true
      responses:
        200:
          description: ""
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: all
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_profiles_patch/invocations"
        type: aws_proxy
    delete:
      description: プロフィールを削除します。
      parameters:
        - name: userId
          description: ""
          in: path
          type: string
          required: true
        - name: Authorization
          description: |
            認証情報です。 Accounts サービスから取得したトークンを `Bearer {TOKEN}` の形式で送信します。
          in: header
          type: string
          required: true
      responses:
        200:
          description: ""
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        404:
          description: |
            Not Found

            たとえ他のドメインに存在していても、サーバは 404 によってその存在を隠す必要があります。
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: params-only
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_profiles_delete/invocations"
        type: aws_proxy
    options:
      consumes:
        - application/json
      parameters:
        - name: userId
          description: ""
          in: path
          type: string
          required: true
        - "$ref": "#/parameters/Authorization_opt"
        - "$ref": "#/parameters/X-Forwarded-For"
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              type: string
            Access-Control-Allow-Methods:
              type: string
            Access-Control-Allow-Credentials:
              type: string
            Access-Control-Allow-Headers:
              type: string
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: '200'
            responseParameters:
              method.response.header.Access-Control-Allow-Credentials: "'true'"
              method.response.header.Access-Control-Allow-Methods: "'GET,PUT,PATCH,DELETE,OPTIONS'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,Pragma,Cache-Control,If-Modified-Since'"
              method.response.header.Access-Control-Allow-Origin: "'__ACCESS_CONTROL_ALLOW_ORIGIN__'"
        requestTemplates:
          application/json: '{"statusCode": 200}'
        passthroughBehavior: when_no_match
        type: mock

  /posts:
    get:
      description: |
        組織名の一覧を取得します。

        クエリパラメータによって絞り込みを行うことができます。
        `q` による検索は、スペース区切りで複数のキーワードを指定できます。
      parameters:
        - "$ref": "#/parameters/Authorization_opt"
        - "$ref": "#/parameters/X-Forwarded-For"
        - name: q
          description: |
            検索に利用するクエリ文字列です（1000文字以内）。
          in: query
          type: string
        - name: limit
          description: |
            検索結果の最大件数を指定します。
            最大（＝デフォルト）値は 100 です。
          in: query
          type: integer
          default: 100
          minimum: 1
          maximum: 100
        - name: exclusiveStartKey
          description: |
            前回の `lastEvaluatedKey` を付与し、ページネーションを行います。
            このキーのデータ以降で、このキーを除くデータが返されます。
          in: query
          type: string
      responses:
        200:
          description: 組織の検索結果を返します。
          schema:
            type: object
            properties:
              profiles:
                type: array
                items:
                  $ref: "#/definitions/Post"
              lastEvaluatedKey:
                type: string
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
      security:
        - CustomAuthorizer: []
      x-amazon-apigateway-request-validator: params-only
      x-amazon-apigateway-integration:
        httpMethod: POST
        responses:
          default:
            statusCode: "200"
        uri: "arn:aws:apigateway:__REGION__:lambda:path/2015-03-31/functions/arn:aws:lambda:__REGION__:__ACCOUNT_ID__:function:${stageVariables.LambdaAlias}profiles_posts_query/invocations"
        type: aws_proxy
    options:
      consumes:
        - application/json
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              type: string
            Access-Control-Allow-Methods:
              type: string
            Access-Control-Allow-Credentials:
              type: string
            Access-Control-Allow-Headers:
              type: string
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: '200'
            responseParameters:
              method.response.header.Access-Control-Allow-Credentials: "'true'"
              method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token,Pragma,Cache-Control,If-Modified-Since'"
              method.response.header.Access-Control-Allow-Origin: "'__ACCESS_CONTROL_ALLOW_ORIGIN__'"
        requestTemplates:
          application/json: '{"statusCode": 200}'
        passthroughBehavior: when_no_match
        type: mock

definitions:
  Profile:
    type: object
    required:
      - userId
      - name
    properties:
      userId:
        type: string
      employeeId:
        type: string
      picture:
        type: string
      name:
        type: string
      ruby:
        type: string
      organization:
        type: string
      post:
        type: string
      rank:
        type: string
      cellPhone:
        type: string
      extensionPhone:
        type: string
      mail:
        type: string
      workplace:
        type: string
  Post:
    type: object
    required:
      - name
    properties:
      name:
        type: string
  Error:
    type: object
    properties:
      message:
        type: string
parameters:
  Authorization:
    name: Authorization
    description: |
      認証情報です。 Accounts サービスから取得したトークンを `Bearer {TOKEN}` の形式で送信します。
    in: header
    type: string
  Authorization_opt:
    name: Authorization
    description: |
      認証情報です。 Accounts サービスから取得したトークンを `Bearer {TOKEN}` の形式で送信します。
    in: header
    required: false
    type: string
  X-Forwarded-For:
    name: X-Forwarded-For
    description: この API は、 IP アドレスによる匿名によるアクセスが可能です。
    in: header
    type: string