Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RESTful Service to list configured Attribute Sets #813

Closed
gunterze opened this issue Jun 23, 2017 · 1 comment
Closed

RESTful Service to list configured Attribute Sets #813

gunterze opened this issue Jun 23, 2017 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@gunterze
Copy link
Member

gunterze commented Jun 23, 2017

Related: #812
swagger.json

{
    "/attribute-set/{type}": {
      "get": {
        "tags": [
          "CONFIG-RS"
        ],
        "summary": "Get Attribute Set",
        "operationId": "getAttributeSet",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "type",
            "in": "path",
            "description": "type of Attribute Sets to return",
            "required": true,
            "type": "string",
            "enum": [
              "DIFF_RS",
              "WADO_RS"
            ]
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "attributeSets.schema.json"
            }
          },
          "default": {
            "description": "unexpected error"
          }
        }
      }
    }
}

attributeSets.schema.json

{
  "title": "Attribute Sets",
  "type": "array",
  "items": {
    "required": [
      "type",
      "id"
    ],
    "properties": {
      "type": {
        "title": "Attribute Set Type",
        "description": "Specifies if this Attribute Set is used by Query Parameter 'comparefield' of DIFF-RS or by Query Parameter 'includefields' of WADO-RS requests.",
        "type": "string",
        "enum": [
          "DIFF_RS",
          "WADO_RS"
        ]
      },
      "id": {
        "title": "Attribute Set ID",
        "description": "ID used by Query Parameter 'comparefield' of DIFF-RS requests and by Query Parameter 'includefields' of WADO-RS Metadata requests to refer this Attribute Set.",
        "type": "string"
      },
      "title": {
        "title": "Attribute Set Title",
        "description": "Title of this Attribute Set.",
        "type": "string"
      },
      "description": {
        "title": "Attribute Set Description",
        "description": "Unconstrained text description of this Attribute Set",
        "type": "string"
      }
    }
  }
}
@gunterze
Copy link
Member Author

gunterze commented Jul 6, 2017

  • rename Attribute Set property name -> id
  • return added Attribute Set property title
  • remove not installed from returned list of attribute sets
  • order list of Attribute Sets by its number

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants