Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Misc — Add examples components for each summarized task type #170

Merged
merged 1 commit into from
Oct 3, 2022

Conversation

gmourier
Copy link
Member

@gmourier gmourier commented Aug 17, 2022

🤖 API Diff


Summary

Add examples components for each summarized task type to make it more precise for the reader and up-to-date with the past changes.

Related to: #141


Changes

n/a

Out Of Scope

n/a


Attention To Reviewers

n/a


Misc

  • Update OpenAPI specification file

@gmourier gmourier added Not A Spec This PR is not a feature specification OpenAPI Update OpenAPI specification. Q3:2022 Catch-Up The PR describes already implemented behaviors. v0.29 labels Aug 17, 2022
@github-actions
Copy link

github-actions bot commented Aug 17, 2022

🚨 Breaking API change detected:

Modified (32)

  • DELETE /indexes/{indexUid}
    • Response added: 202
    • [Breaking] Response removed: 204
  • DELETE /indexes/{indexUid}/documents
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/documents/{documentId}
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/displayed-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/distinct-attribute
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/faceting
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/filterable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/pagination
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/ranking-rules
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/searchable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/sortable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/stop-words
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/synonyms
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • DELETE /indexes/{indexUid}/settings/typo-tolerance
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PATCH /indexes/{indexUid}
    • Response added: 202
    • [Breaking] Response removed: 200
  • PATCH /indexes/{indexUid}/settings
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PATCH /indexes/{indexUid}/settings/faceting
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PATCH /indexes/{indexUid}/settings/pagination
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PATCH /indexes/{indexUid}/settings/typo-tolerance
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • POST /indexes
    • Response added: 202
    • [Breaking] Response removed: 201
  • POST /indexes/{indexUid}/documents
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • POST /indexes/{indexUid}/documents/delete-batch
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/documents
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/displayed-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/distinct-attribute
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/filterable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/ranking-rules
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/searchable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/sortable-attributes
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/stop-words
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed
  • PUT /indexes/{indexUid}/settings/synonyms
    • [Breaking] Response modified: 202
      • [Breaking] Body attributes removed: taskUid, indexUid, status, type, enqueuedAt, Additional properties are NOT allowed

View documentation diff

Powered by Bump

@gmourier gmourier force-pushed the misc-add-missing-202-responses branch from 2673ffd to bd6a387 Compare August 17, 2022 14:09
@gmourier gmourier force-pushed the misc-add-missing-202-responses branch from bd6a387 to 871e3b1 Compare August 17, 2022 14:14
@gmourier gmourier mentioned this pull request Aug 17, 2022
1 task
@gmourier gmourier merged commit dbdae7a into develop Oct 3, 2022
@gmourier gmourier deleted the misc-add-missing-202-responses branch October 3, 2022 14:55
gmourier added a commit that referenced this pull request Oct 3, 2022
* Bump openapi spec version to v0.29

* Update 0001-script-based-tokenizer.md (#159)

Change tokenizer specs to better fit Charabia implementation

* Update the geosearch error (#161)

Implemented in meilisearch/milli#561

* Auto-batching - Enable feature by default and remove unwanted options (#162)

* Update specs according to new auto-batching behavior

* update batchUid to make it internal and hidden from a task resource representation

* Remove the batchUid mentions from the task API

* Update open-api.yaml

Co-authored-by: Guillaume Mourier <[email protected]>

* update future possibilities

Co-authored-by: Guillaume Mourier <[email protected]>

* Search API — Filters - Introduce IN and EXISTS and describe filter capabilities in more precisely (#163)

* Write a specification for the new (and old) search filters

EXISTS
IN
NOT (new behaviour)
!= (new behaviour)

* Apply suggestions from code review

Co-authored-by: Tamo <[email protected]>
Co-authored-by: Guillaume Mourier <[email protected]>

Co-authored-by: Tamo <[email protected]>
Co-authored-by: Guillaume Mourier <[email protected]>

* Add missing settings object in the task details field of a settingsUpdate task type (#164)

* Remove `name` from indexes resource definition (#165)

* Misc — Soft deleted documents (Performance optimization) (#168)

* create a spec for the soft deleted documents

* Rename spec file, minor adjustements

* Replace You and We by A user and Meilisearch

Co-authored-by: Guillaume Mourier <[email protected]>

* Add Stats Seen event (#169)

* Add examples component for each summarized task type (#170)

* Version API — Catch up (#171)

* Add version-api.md

* Add PR number as a spec file prefix

* Add health-api.md (#172)

* Search API — Add `matchingStrategy` parameter with `last` / `all` strategies (#173)

* Introduce a proposal to boot the specification

* Update telemetry

* Replace wordMatchingStrategy by matchingStrategy

* fix missing backtick md

Co-authored-by: Many the fish <[email protected]>
Co-authored-by: Tamo <[email protected]>
Co-authored-by: Clémentine Urquizar - curqui <[email protected]>
Co-authored-by: Loïc Lecrenier <[email protected]>
Co-authored-by: cvermand <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Catch-Up The PR describes already implemented behaviors. Not A Spec This PR is not a feature specification OpenAPI Update OpenAPI specification. Q3:2022 v0.29
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant