diggsweden / sdk-docs

Dokumentation för SDK-projeket.
Creative Commons Zero v1.0 Universal
3 stars 2 forks source link

SDK-API: Filter definition is wrong #9

Open mcNisse opened 1 week ago

mcNisse commented 1 week ago

Contact Details (Optional)

johan.erlands@idainfront.se

What happened?

When using generated service stubs you get an list of filters. The list is empty untill you write ?filter=bar&filter=foo. This is not the way it is described in the pdf. Where you say that ?filter[recipientAttention.subOrganization.extension]=org.funk1 should be used.

This is fixed by saying that filter is an object with properties. As a bunus you will describe all filter conditions.

        - in: query
          name: filter
          required: true
          description: "The filter query parameter family is reserved to be used as the basis for any filtering of strategy. ?Filter[attribute]=value"
          example: '?filter[recipientAttention.subOrganization.extension]=sdk:inkorg001:0203:inera.se'
          schema:
            type: object
            properties:
              recipientAttention.subOrganization.extension:
                type: string
              senderAttention.subOrganization.extension:
                type: string
          ...
          style: deepObject
          explode: true

Steps To Reproduce

What did you expect?

Filter is reaching the stubs.

Version (Optional)

No response

Screenshots (Optional)

No response

Relevant log output (Optional)

No response

marcodeluca1 commented 1 week ago

Tack för förbättringsförslag. Vi försöker åtgärda detta vid kommande uppdateringar.