Документы для сдачи объекта в эксплуатацию документы: Какие документы нужны для выдачи разрешения на ввод объекта в эксплуатацию?

Содержание

Перечень документов при подготовке заключения на ввод объекта в эксплуатацию

Получение разрешения от государства для эксплуатации здания после строительства, реконструкции или ремонта довольно сложно и требует наличие определенного комплекса документов. Прежде чем приступать к сбору всех бланков, необходимо определиться со следующими вопросами:

  1. Какие удостоверения нужны для получения разрешения от государства на введение объекта в эксплуатацию.
  2. В каких случаях разрешение от государства не требуется.
  3. Каким образом заключение можно получить.

Подготовка документов

Для того чтобы с законодательством не возникало проблем, необходимо позаботиться о правильном выполнении всех его требований. Так, чтобы приобрести разрешение на ввод объекта в эксплуатацию нужно заблаговременно собрать все имеющиеся свидетельства и удостоверения, которые относятся к имеющемуся земельному участку и постройкам.

Какие удостоверения нужны для получения разрешения от государства на введение объекта в эксплуатацию

Среди перечня необходимых бумаг, стоит выделить:

  • Свидетельство о собственности и другие постановления, которые определяют владение земельным участком определенной личностью.
  • Градостроительный план имеющегося участка. Он может не понадобиться, если ремонт не будет осуществляться за счет изменения габаритов здания.
  • Разрешение на проведенное строительство, в котором будет указан временной интервал работ.
  • Заключение соответствующей инспекции строительного надзора относительно соответствия данного объекта всем требованиям техники безопасности.
  • Акт, составленный между застройщиком и заказчиком о приемке работы. К нему нужно будет приложить договор подряда и лицензию этой организации на выполнение работ.
  • Справки, полученные от организации подрядчиков относительно соответствия работы всем регламентам и идентичности с документацией проекта, которые подписаны как застройщиком, так и заказчиком.
  • Удостоверение ООО ВДПО, которое фиксирует периодическое очищение вентиляционных каналов и дымоходов.
  • Свидетельство о выполнении установки охранно-пожарной системы.
  • Исполнительная съемка, которая заключается в топографическом снимке объекта с указанием всех элементов благоустройства.
  • Фотография объекта и прилегающей территории.
  • Паспорт, полученный от ФГУП «Ростехинвентаризация».
  • Лицензия главного проектировщика.
  • Свидетельство относительно присвоения почтовой нумерации.

Комплект всех этих документов позволит получить долгожданное заключение от государства.

В каких случаях разрешение от государства не требуется?

Можно обойтись без бюрократического процесса сбора документов только в случае отсутствия получения свидетельств о проведении строительных работ. Если ремонт был проведен внутри помещения без изменения его габаритов и элементов благоустройства, тогда возникает ситуация когда не требуется разрешения на ввод объекта в непосредственную эксплуатацию.

Каким образом получить заключение?

Для того чтобы получить необходимое свидетельство соответствующей организацией, владеющей правом на предоставление объектам возможности эксплуатации, необходимо действовать по следующему принципу:

  • Предварительно прозвонить в главный офис или нанести визит с целью оформления заявления. Таким образом, заказчик получает время на сбор нужных свидетельств, а организация начинает составлять базу данных, являющейся основой для выдачи протокола.
  • После предоставления всех документов потребуется недельный срок, чтобы сотрудники офиса смогли с ними ознакомиться, проверить и составить заключение.  Не стоит приобретать какие-либо свидетельства, не соответствующие действительности.
  • После проверки удостоверений и справки, если были выявлены неточности, сотрудники организации обязуются провести консультацию и объяснить, что необходимо сделать для получения разрешения.

Таким образом, в учреждении можно как получить позволение на ввод объекта в непосредственную эксплуатацию, так и проконсультироваться относительно возможных проблем с документами.

Акты и документы для ввода объекта строительства в эксплуатацию

По завершении строительства новый объект необходимо ввести в эксплуатацию, так как без специального акта его использование категорически запрещено. Если вы желаете избавить себя от хлопот в виде многочисленных походов по государственным инстанциям, сбора и подготовки необходимых документов, доверьте решение задачи специалистам компании «Гилберт Инвест». 

Этапы получения разрешения

Акты и документы для ввода объекта строительства в эксплуатацию эксперты «Гилберт Инвест» получают, проведя многоэтапный комплекс мероприятий:

  1. Сбор пакета документов.
    По окончании строительных работ у вас на руках должен быть полный пакет документов: разрешительная и проектно-сметная документация, письменное уведомление от подрядчика об окончании работ, акт выполненных работ, список привлекаемых во время стройки подрядчиков с указанием данных ответственных лиц, информация о подводе коммуникаций и других специализированных работах. 

    Особое внимание специалисты уделяют наличию и содержанию технической документации. Должна быть указана информация об используемых во время стройки материалах. Пакет документов составляют также акты геодезических изысканий, технический паспорт, журнал контроля и авторского надзора, акты о выполнении определенных видов работ и так далее.

  2. Предварительная проверка.
    Цель — оценка готовности нового сооружения к приемке. Данный этап заключается в создании рабочей комиссии. В ее состав входят сотрудники надзорных органов, эксплуатационных служб, проектной организации и, конечно, специалист «Гилберт Инвест» в качестве вашего представителя. 

    Задача рабочей группы — проверить имеющиеся документы на комплектность и ошибки, оценить, соответствуют ли элементы постройки проектным требованиям. В рамках исследования осуществляется пробный запуск инженерного оборудования и коммуникаций. 

    Выводы членов комиссии о соответствии проверяемого сооружения техническим условиям и нормам отражаются в итоговом заключении. Оно же является основанием для выдачи решения о вводе объекта недвижимости в эксплуатацию.

  3. Подача заявления.
    Рассмотрением данного вопроса занимается Главное управление архитектуры. От вашего имени будет подано заявление с полным пакетом необходимых документов.
  4. Получение разрешения.
    В течение 10 дней управление проверяет поданную информацию, выезжает по указанному адресу для повторного осмотра и оценки объекта, составляют специальный акт, на основании которого и принимается решение о выдаче разрешающего документа. Оно может быть отрицательным в случае выявления нарушений и несоответствий. Однако сотрудничая с компанией «Гилберт Инвест», цена на услуги которой отличается доступностью, вы с такими проблемами не столкнетесь.

Преимуществами


«Гилберт Инвест» являются:

  • Многолетний опыт работы.
  • Команда профессиональных исполнителей.
  • Индивидуальный подход, использование эксклюзивных методик.
  • Гарантия выполнения всех обязательств.
  • Сеть представительств по всей России.

Ориентированность на результат является причиной того, что «Гилберт Инвест» — это признанный эксперт и узнаваемый бренд не только внутри страны, но и за ее пределами. В числе постоянных клиентов немало зарубежных предприятий.

Кроме получения актов и документов для ввода объекта в эксплуатацию, специалисты оказывают следующие услуги:

Проконсультироваться или заказать проведение работ вы можете, оставив заявку на обратный звонок.

Популярные экспертизы и услуги

Строительный надзор и контроль — ввод в эксплуатацию и разрешение на строительство

Специалист сопровождает Заказчика строительства Объекта при получении разрешения на строительство и вводе объекта в эксплуатацию.

На этапе получения разрешения на строительство:

  • Формируется комплект проектной и исходно-разрешительной документации для получения разрешения на строительство.
  • Формируется комплект полного пакета документов
  • Проводится анализ имеющихся у Заказчика справок и документов, а также Градостроительный анализ земельного участка
  • Осуществляется получение разрешения на строительство объекта

На этапе подготовки:

  • Сопровождение проведения необходимых обследований сторонними организациями по отдельным договорам (санитарно-эпидемиологические исследования; энергообследование; техническая инвентаризация и другие, при необходимости).
  • Анализ выявленных нарушений.
  • Координация устранения нарушений силами генеральной подрядной организацией и генеральным проектировщиком.
  • Формирование комплекта необходимых документов для получения заключения о соответствии построенного объекта требованиям технических регламентов
  • Формирование комплекта необходимых документов для получения разрешения на ввод Объекта в эксплуатацию.
  • Сопровождение получения разрешения.

ООО «Северо-Западный Экспертный Центр» оказывает помощь в оформлении документов для ввода объектов в эксплуатацию. У нас вы можете пройти экспертизу и получить документы для нежилых помещений, объектов индивидуального жилищного строительства, а также объектов после капитального ремонта или перепланировки. Мы имеем большой опыт в оказании услуг по оформлению и оценке проектной документации. Наша основная задача заключается в предоставлении услуг в соответствии с законодательством, которые, в свою очередь, способствуют повышению качества возводимых объектов.

Наши специалисты учитывают пожелания клиентов. Однако приоритетом являются, конечно же, требования законодательства в сфере строительства. Все экспертно-оценочные работы представляют собой проверку на соответствие нормативным актам. Все это позволяет предоставлять качественные услуги в строго оговоренные законом сроки. Многие клиенты уже оценили преимущества работы с нами, так как мы не ограничиваемся одной лишь проверкой документации. Чтобы ввод в эксплуатацию объектов клиентов прошел успешно, мы оказываем консультации и помощь на всех этапах оформления документации.

Ввведение объектов капитального строительства

Ввод в эксплуатацию объекта является заключительным этапом архитектурно-строительного проектирования и согласования проектной документации. Если готовый объект будет полностью соответствовать заявленной документации, это гарантирует получение акта. Порядок оформления объектов капитального строительства регламентируется законом. Информация об этом представлена в статье 55 Градостроительного Кодекса РФ, которая так и называется: «Выдача разрешения на ввод объекта в эксплуатацию».

Согласно Градостроительному Кодексу, разрешение на ввод в эксплуатацию – это документ, который подтверждает, что строительство (реконструкция, капитальный ремонт) объекта выполнены в соответствии с полученным разрешения. Также в документе указывается, что объект построен (реконструирован, отремонтирован) в соответствии с градостроительным планом земельного участка. Если объект – линейный, то он должен быть построен в соответствии с проектной документацией, проектом межевания и проектом планировки территории. Ввод в эксплуатацию любого объекта возможен только тогда, когда застройщик предоставит разрешение на строительство (реконструкцию, перепланировку и т.д.)

Чтобы начать процесс ввода объекта в эксплуатацию, застройщику необходимо обратиться с заявлением в уполномоченные органы исполнительной власти. К заявлению надо приложить пакет документов, перечень которых определяется законодательством. В перечень входят:

  • Градостроительный план земельного участка с правоустанавливающими документами на него;
  • Акт приемки объекта капитального строительства;
  • Разрешение на проведение строительных работ;
  • Схемы размещение инженерных сетей и акты их приемки;
  • Справки, которые подтверждают соответствие объекта требованиям технических регламентов и другим законодательным актам. Справки должны быть подписаны лицом, осуществляющим строительство.
  • Соответствие объекта тех. условиям. Справки должны быть подписаны представителями организаций, которые осуществляют эксплуатацию сетей инженерно-технического обеспечения.
  • Документы, которые подтверждают соответствие построенного (реконструированного, отремонтированного) объекта капитального строительства проектной документации. В документах должны быть отражены, в том числе, сведения об энергетической эффективности об оснащенности объекта капитального строительства приборами учета.
  • Схемы расположения построенного (реконструированного) объекта и планировочная организация земельного участка.
  • Заключение уполномоченного органа Государственного строительного надзора о соответствии построенного (реконструированного) объекта проектной документации и требованиям технических регламентов.
  • Документы, которые подтверждают наличие договора обязательного страхования гражданской ответственности владельца объекта капитального строительства за причинение вреда в результате аварии на этом объекте.

Чтобы получить акт ввода в эксплуатацию линейного объекта, необходимо предоставить проект планировки территории и проект межевания территории вместо градостроительного плана. Схему расположения объекта в этом случае предоставлять не надо.

Государственные органы могут отказать в выдаче акта по следующим причинам:

  • Неполный комплект документов из указанного списка;
  • Несоответствие объекта капитального строительства требованиям градостроительного плана земельного участка или требованиям проекта планировки территории;
  • Несоответствие объекта капитального строительства требованиям разрешения на строительство;
  • Несоответствие проектной документации (исключения допускаются для объектов индивидуального жилищного строительства, на которые не распространяется это требование).

Ввведение объектов после перепланировки

После проведения перепланировки или переводе объекта в нежилой фонд необходимо провести процедуру ввода объекта в эксплуатацию. Перечень документов здесь не такой большой, как при только что построенных или реконструированных объектов. Но это не означает, что к процедуре можно отнестись несерьезно. Заявителю может быть отказано по нескольким причинам, если его документация будет оформлена неправильно, а в ходе работ по перепланировке будут допущены недочеты.

Перепланировки нужно предоставить следующие документы:

  • Результаты новых обмеров проектно-инвентаризационным бюро;
  • Документы на строительно-монтажные работы от организации, которая занималась перепланировкой;
  • Правоустанавливающие документы на объект;
  • Заключение государственных органов (СЭС, КУГИ, пожарный надзор и другие) о соответствии работ по перепланировке требованиям безопасности.

Подтверждением является акт ввода в эксплуатацию, который подписывается членами комиссии после исследования объекта. На основании акта оформляется новый кадастровый паспорт, и вносятся изменения в ЕГРП.

Ввод построенного объекта

Ввод в эксплуатацию законченного строительством здания или сооружения осуществляется после проверки приемочной комиссии. Она принимает решение о соответствии объекта документации и возможности его эксплуатации без вреда жизни и здоровью людей. Акт приемки объекта утверждается председателем приемочной комиссии. Утвержденный акт подтверждает создание нового объекта и является основанием для включения объекта в другие документы и реестры.

Специалисты ООО «Северо-Западный Экспертный Центр» оказывают помощь на всех этапах оформления проектной и иной документации, необходимой для ввода объекта в эксплуатацию. У нас вы можете получить документы, которые имеют такую же юридическую силу, что и решения государственных учреждений в сфере строительного надзора и экспертизы.

Выдача разрешения на ввод объекта в эксплуатацию

1.Документ, удостоверяющий личность заявителя (заявителей), являющегося физическим лицом, либо личность представителя физического или юридического лица (за исключением случая обращения с заявлением о предоставлении услуги в электронной форме)

2. Документ, удостоверяющий права (полномочия) представителя физического или юридического лица, если с заявлением обращается представитель заявителя (заявителей)

3.Правоустанавливающий документ на земельный участок, если право на него не зарегистрировано в Едином государственном реестре недвижимости (при наличии)

4.Соглашение об установлении сервитута в отношении земельного участка, в случае установления сервитута и при условии, что сервитут не зарегистрирован в Едином государственном реестре недвижимости (далее – ЕГРН)

5.Акт приемки объекта капитального строительства (в случае осуществления строительства, реконструкции на основании договора строительного подряда)

6.Акт, подтверждающий соответствие параметров построенного, реконструированного объекта капитального строительства проектной документации, в том числе требованиям энергетической эффективности и требованиям оснащенности объекта капитального строительства приборами учета используемых энергетических ресурсов, и подписанный лицом, осуществляющим строительство (лицом, осуществляющим строительство, и застройщиком или техническим заказчиком в случае осуществления строительства, реконструкции на основании договора строительного подряда, а также лицом, осуществляющим строительный контроль, в случае осуществления строительного контроля на основании договора)

7.Документы, подтверждающие соответствие построенного, реконструированного объекта капитального строительства техническим условиям и подписанные представителями организаций, осуществляющих эксплуатацию сетей инженерно-технического обеспечения (при их наличии)

8.Схема, отображающая расположение построенного, реконструированного объекта капитального строительства, расположение сетей инженерно-технического обеспечения в границах земельного участка и планировочную организацию земельного участка и подписанная лицом, осуществляющим строительство (лицом, осуществляющим строительство, и застройщиком или техническим заказчиком в случае осуществления строительства, реконструкции на основании договора строительного подряда), за исключением случаев строительства, реконструкции линейного объекта

9. Документ, подтверждающий заключение договора обязательного страхования гражданской ответственности владельца опасного объекта за причинение вреда в результате    аварии   на   опасном   объекте  в  соответствии   с   законодательством Российской Федерации об обязательном страховании гражданской ответственности владельца опасного объекта за причинение вреда в результате аварии на опасном объекте 

10.Технический план объекта капитального строительства, подготовленный в форме электронного документа и заверенного усиленной квалифицированной электронной подписью кадастрового инженера (на электронном носителе)»;

Выдача разрешения на ввод в эксплуатацию объектов капитального строительства, расположенных на территории муниципального образования "город Екатеринбург" — Список статей — Главная — Министерство строительства и развития инфраструктуры Свердловской области Официальный сайт

1. Федеральный закон от 25 июня 2002 г. N 73-ФЗ "Об объектах культурного наследия (памятниках истории и культуры) народов Российской Федерации". 

2. Федеральный закон от 29.12.2004 N 191-ФЗ "О введении в действие Градостроительного кодекса Российской Федерации". 

3. Постановление Правительства РФ от 22 декабря 2012 г. N 1376 "Об утверждении Правил организации деятельности многофункциональных центров предоставления государственных и муниципальных услуг". 

4. Федеральный закон от 13.07.2015 N 218-ФЗ "О государственной регистрации недвижимости". 

5. Градостроительный кодекс Российской Федерации от 29.12.2004 N 190-ФЗ. 

6. Федеральный закон от 27 июля 2010 г. N 210-ФЗ "Об организации предоставления государственных и муниципальных услуг". 

7. Земельный кодекс Российской Федерации от 25.10.2001 N 136-ФЗ (ред. от 27.06.2019). 

8. Федеральный закон от 02.05.2006 N 59-ФЗ "О порядке рассмотрения обращений граждан Российской Федерации".  

9. Постановление Правительства Свердловской области от 22.11.2018 N 828-ПП "Об утверждении положения об особенностях подачи и рассмотрения жалоб на решение и действие (бездействие) исполнительных органов государственной власти свердловской области, предоставляющих государственные услуги, их должностных лиц, государственных гражданских служащих исполнительных органов государственной власти свердловской области, предоставляющих государственные услуги, а также на решения и действия (бездействие) многофункционального центра предоставления государственных и муниципальных услуг и его работников". 

10. Приказ Министерства строительства и развития инфраструктуры Свердловской области от 07.05.2019 № 305-П: "Об утверждении Административного регламента предоставления Министерством строительства и развития инфраструктуры Свердловской области государственной услуги "Выдача разрешения на ввод в эксплуатацию объектов капитального строительства, расположенных на территории муниципального образования "город Екатеринбург". 

11. Постановление Правительства Российской Федерации от 01.03.2013 № 175 "Об установлении документа, необходимого для получения разрешения на ввод объекта в эксплуатацию". 

12. Постановление Правительства РФ от 16.02.2008 N 87 (ред. от 17.09.2018) "О составе разделов проектной документации и требованиях к их содержанию". 

13. Постановление Правительства РФ от 16 мая 2011 г. N 373 "О разработке и утверждении административных регламентов исполнения государственных функций и административных регламентов предоставления государственных услуг". 

14. Приказ Минстроя России от 19.02.2015 N 117/пр "Об утверждении формы разрешения на строительство и формы разрешения на ввод объекта в эксплуатацию". 

15. Постановление Правительства Свердловской области от 11 ноября 2015 года N 1043-ПП "Об утверждении положения, структуры, предельного лимита штатной численности и фонда по должностным окладам в месяц Министерства строительства и развития инфраструктуры Свердловской области".  

16. Постановление Правительства РФ от 06.05.2011 N 352 (ред. от 25.06.2019) "Об утверждении Перечня услуг, которые являются необходимыми и обязательными для предоставления исполнительными органами государственной власти Свердловской области государственных услуг и предоставляются организациями, участвующими в предоставлении государственных услуг, и Порядка определения размера платы за оказание услуг, которые являются необходимыми и обязательными для предоставления исполнительными органами государственной власти Свердловской области государственных услуг". 

17. Постановление Правительства Свердловской области от 11 ноября 2015 года N 1043-ПП "Об определении Министерства строительства и развития инфраструктуры Свердловской области исполнительным органом государственной власти Свердловской области, осуществляющим отдельные полномочия в сфере градостроительной деятельности". 

18. Закон Свердловской области от 12.10.2015 N 111-ОЗ "О перераспределении отдельных полномочий в сфере градостроительной деятельности между органами местного самоуправления муниципального образования "город Екатеринбург" и органами государственной власти Свердловской области". 

19. Решение Екатеринбургской городской Думы Решение Екатеринбургской городской Думы от 27.10.2009 N 46/11 "Об образовании особо охраняемых природных территорий местного значения в муниципальном образовании "город Екатеринбург"

Разрешение на ввод объекта в эксплуатацию в 2021 году (согласие)

Автор: Александра Рожкова

Заключительной стадией строительства является получение такого документа, как разрешение на ввод объекта в эксплуатацию. Как получить разрешение, и какие документы потребуется оформить предварительно, читайте далее.

Что это за документ, как выглядит и для чего нужен

Разрешение на введение объекта капитального строительства в эксплуатацию после постройки или реконструкции – это юридический документ, которым удостоверяются следующие факторы (статья 55 Градостроительного кодекса):

  • соответствие здания проектной документации
  • соответствие строения полученному на начальной стадии разрешению
  • соблюдение требований безопасности установленных соответствующими нормативными актами
  • соответствие градостроительному плану или плану застройки определенной территории
  • соответствие строения установленной категории разрешенного использования для земельного участка

Получение разрешения является окончательной стадией строительства перед непосредственным использованием строения.

Форма документа установлена Приложением 2 к Приказу Минстроя №117.

В разрешении должна быть отражена следующая информация:

  • кому выдается документ: наименование застройщика, юридический адрес и контактный телефон. Если стройка или реконструкция производились частным лицом, то указываются ФИО и адрес проживания гражданина
  • дата выдачи и порядковый номер документа
  • полное наименование органа, выдавшего разрешение
  • название и адрес расположения недвижимости, в отношении которой выдается разрешение на использование
  • кадастровый номер земельного участка, на котором возведено здание
  • реквизиты разрешения на строительство, выданного уполномоченными органами
  • технические характеристики строения: общая площадь, площадь жилых или нежилых помещений, количество отдельных помещений, количество этажей, наличие технических сооружений, лифтов, коммуникационных сетей и так далее
  • соответствие требованиям энергетической эффективности и правильности установки индивидуальных приборов учета

Когда выдаётся (сроки)

Разрешение на ввод строения в пользование выдается при строительстве новых зданий или после проведения капитального ремонта строений любого назначения, если для строительства требуется получение специального разрешения.

Разрешение на строительство и соответственно введение в пользование необходимо, если производится строительство/реконструкция (статья 51 Гражданского кодекса):

  • любого объекта на земельном участке, предназначенном для разработки недр
  • капитального строения, относящегося к сферам производства или использования атомной энергии или космоса
  • сооружений гидротехнического назначения
  • капитальных зданий, располагаемых на землях, относящихся к особо охраняемым территориям

Для получения разрешения на ввод строения в использование требуется не более 7 рабочих дней при условии наличия всех документов, перечень которых устанавливается законодательно.

Кто выдаёт

Застройщик или его представитель могут получить разрешение на ввод в федеральных, региональных или муниципальных органах власти, которыми выдавалось разрешение на строительство.

В исключительных случаях выдачей документов занимаются такие организации, как:

  • Росатом
  • Роскосмос

Указанные структуры работают в соответствии со следующим нормативными документами:

  • Градостроительным кодексом
  • Постановлением Правительства РФ N 92 об уполномоченных органах, имеющих право выдавать разрешения
  • Приказом Министерства регионального развития Российской Федерации №251, регламентирующим порядок выдачи разрешений

Где хранятся выданные документы и где посмотреть информацию о наличии/отсутствии разрешения на ввод здания?

Все выданные уполномоченными государственными органами документы хранятся в едином реестре, ознакомится с которым можно на официальном сайте Минстроя.

Процедура получения

Чтобы получить разрешение на введение здания в эксплуатацию необходимо подать письменное заявление в соответствующие органы, к которому приложить установленный статьей 55 Градостроительного кодекса перечень документов.

Подать заявление можно:

  • лично в выбранной организации
  • через многофункциональный центр
  • по почте
  • через портал Государственных услуг (на данный момент услуга доступна только в нескольких регионах РФ. Более подробную информацию о возможности подачи документов онлайн рекомендуется уточнить на сайте регионального правительства)

Документы

Перед подачей заявления на получения разрешения на ввод требуется подготовить следующий пакет документов:

  • свидетельство о регистрации, выписка из ЕГРН или иной документ, которым подтверждается право владения земельным участком, на котором произведено строительство/реконструкция
  • градостроительный план
  • разрешение на строительство
  • технический план сооружения
  • акты, подтверждающие соответствие постройки нормам безопасности, регламенту застройки, технической документации и так далее
  • заключение о соответствии строения требованиям безопасности
  • схемы расположения здания и всех коммуникаций на земельном участке
  • договор страхования (оформляется исключительно в отношении объекта, отнесенного к категории опасных)
  • акт о сохранении объекта культурного наследия в надлежащем виде (выдается при проведении капитального ремонта соответствующих строений)

Все документы предоставляются в оригиналах или копиях, заверенных нотариально. В случае подачи онлайн документы должны быть подписаны усиленной электронной подписью.

Заявление о выдаче разрешения на ввод объекта в эксплуатацию (образец)

Указанный перечень документов прилагается к письменному заявлению, являющемуся основанием для выдачи разрешения на ввод. Заявителем указываются:

  • наименование органа, имеющего право на выдачу документа
  • данные заявителя наименование компании или ФИО частного лица, адрес регистрации/проживания, контактный телефон
  • название объекта капитального строительства, в отношении которого выдается разрешение
  • адрес расположения земельного участка и реквизиты документа, удостоверяющего право собственности
  • данные организаций застройщика, заказчика, контрольного органа и так далее

Внесение изменений в разрешение

Порядок внесения изменений в разрешительную документацию аналогичен порядку получения документа, то есть в орган, выдавший разрешение подается заявление с определенным перечнем документов.

Внесений изменений допустимо исключительно в следующих ситуациях:

  • в ходе составления документа допущена ошибка/опечатка
  • необходимо произвести некоторое уточнение в отношении объекта недвижимости

Причины для отмены

В соответствии с пунктом 6 статьи 55 Градостроительного кодекса можно получить отказ в выдаче разрешения по следующим причинам:

  • отсутствует один или несколько документов из утвержденного перечня
  • возведенный объект недвижимости не соответствует техническим условиям, нормам безопасности, градостроительному плану или разрешительной документации
  • нарушены правила использования земельного участка (несоответствие строения заявленной категории надела)

Отказ в выдаче разрешения может быть оспорен в суде.

Когда не требуется получать

Получение разрешения не требуется, если произведено строительство (капитальный ремонт):

  • дома или гаража, расположенного на садовом участке или земле, предназначенной для индивидуального жилищного строительства, при условии, что строения имеют не более 2-х этажей
  • объектов вспомогательного назначения на личных участках
  • при реконструкции строений без переделки несущих элементов зданий

Акт ввода в эксплуатацию (образец)

На основании разрешения о вводе строения в эксплуатацию оформляется акт ввода, в котором указываются:

  • дата составления, номер приказа – основания, наименование организации-составителя
  • порядковый номер акта
  • наименование заказчика и коды строительной организации
  • наименование объекта недвижимости
  • название и данные представителей заказчика и исполнителя строительных работ
  • данные акта приемки строения
  • стоимость основных фондов, строительных работ, дополнительного оборудования
  • решение о вводе

* Выдача разрешения на ввод объекта в эксплуатацию / Услуги / Мои документы

  • Акт (протокол, приказ) об избрании руководителя

    Предоставляется в случае обращения руководителя юридического лица.
    Копия и оригинал для сверки.

  • Акт приемки выполненных работ по сохранению объекта культурного наследия

    В случае реставрации, консервации, ремонта объекта культурного наследия.
    Копия и оригинал для сверки.

  • Акт приемки объекта капитального строительства (справка КС-11)

    Предоставляется в случае осуществления строительства, реконструкции, капитального ремонта на основании договора.
    Оригинал.

  • Выписка из ЕГРИП

    Предоставляется по желанию заявителя - индивидуального предпринимателя.
    Оригинал

  • Выписка из ЕГРЮЛ

    Предоставляется по желанию заявителя - юридического лица.
    Оригинал

  • Градостроительный план земельного участка_

    Предоставляется по желанию заявителя.
    Копия и оригинал для сверки.

  • Доверенность на представителя

    Копия и оригинал для сверки
    При обращении представителя юридического лица

  • Договор обязательного страхования гражданской ответственности владельца "опасного" объекта

    Предоставляется в случае, если объект признан "опасным" (многоквартирные многоэтажные дома, здания с лифтами, с эскалаторами).
    Копия и оригинал для сверки.

  • Документ о соответствии проектной документации

    Предоставляется в любом случае, за исключением случаев осуществления строительства объектов ИЖС. Подписывается лицом, осуществляющим строительство, и застройщиком или заказчиком в случае осуществления строительства, реконструкции, капитального ремонта на основании договора).
    Оригинал.

  • Документ о соответствии техническим условиям

    Предоставляется при наличии сетей инженерно-технического обеспечения. Подписывается представителями организаций, осуществляющих эксплуатацию сетей инженерно-технического обеспечения.
    Оригинал.

  • Заключение органа строительного надзора

    Предоставляется в случае, если предусмотрено осуществление государственного строительного надзора.
    Оригинал.

  • Заключение федерального государственного экологического надзора

    Предоставляется в случае, если предусмотрено осуществление государственного строительного надзора в отношении объектов, строительство, реконструкция которых осуществляются в исключительной экономической зоне Российской Федерации, на континентальном шельфе Российской Федерации, во внутренних морских водах, в территориальном море Российской Федерации, на землях особо охраняемых природных территорий, на искусственных земельных участках на водных объектах, и государственного надзора за состоянием, содержанием, сохранением, использованием, популяризацией и государственной охраной объектов культурного наследия при проведении работ по сохранению объектов культурного наследия.
    Оригинал.

  • Кадастровая выписка земельного участка

    Предоставляется по желанию заявителя
    Оригинал

  • Нотариальная доверенность на заявителя

    Предоставляется в случае обращения представителя заявителя - физического лица.
    Копия и оригинал для сверки.

  • Планировочная организация земельного участка

    Предоставляется в случае, если строительство, реконструкция осуществлялось на основании договора, за исключением случаев строительства, реконструкции линейного объекта.
    Копия и оригинал для свекри.

  • Правоустанавливающий документ

    Предоставляется по желанию заявителя.
    Копия и оригинал для сверки.

  • Проект межевания территории

    В случае строительства, реконструкции линейного объекта.
    Копия и оригинал для сверки.

  • Проект планировки территории

    В случае строительства, реконструкции линейного объекта.
    Копия и оригинал для сверки.

  • Разрешение на отклонение от предельных параметров разрешенного строительства/реконструкции

    Предоставляется по желанию заявителя, в случае, если было выдано.
    Копия и оригинал для сверки.

  • Разрешение на строительство

    Предоставляется по желанию заявителя.
    Оригинал.

  • Ссылка на объекты Operations Manager в новом или существующем документе Visio

    • 3 минуты на чтение

    В этой статье

    Надстройка Visio для System Center - Operations Manager позволяет связываться с объектами Operations Manager для представления информации о состоянии работоспособности в новом или существующем чертеже Microsoft Visio.

    Для этого сначала нужно указать сервер управления Operations Manager, с которого надстройка Visio будет запрашивать информацию об управляемых объектах и ​​их состоянии работоспособности.Затем вы добавляете ссылки одним из следующих способов:

    • Свяжите одну фигуру с управляемым объектом. Вы можете быстро связать несколько фигур с любым объектом, управляемым Operations Manager.

    • Добавьте несколько ссылок в документ, а затем свяжите их с фигурами Visio позже. Этот вариант лучше всего подходит для больших документов, содержащих много разных типов управляемых объектов.

    • Автоматически связывать фигуры в документе с компьютерами или сетевыми устройствами.В этом варианте используется один мастер для автоматического добавления информации о состоянии работоспособности в большие и сложные схемы сети или топологии.

    • Вставьте новую фигуру, связанную с объектом Operations Manager и использующую значки Operations Manager.

    Свяжите одну фигуру Visio с объектом, управляемым Operations Manager

    1. Щелкните Operations Manager на ленте, а затем щелкните Форма связи .

    2. Выберите класс объекта Operations Manager, например Компьютер с Windows , чтобы отобразить отфильтрованный список доступных объектов Operations Manager.

    3. Выберите объект, который вы хотите связать с этой формой, а затем щелкните Ссылка .

    Теперь фигура на диаграмме включает индикатор состояния в правом верхнем углу изображения.

    Добавить несколько ссылок на объекты, управляемые Operations Manager

    1. Щелкните Operations Manager на ленте, а затем щелкните Добавить связи данных .

    2. Выберите класс для формы и нажмите ОК .

    3. Выберите управляемые объекты, которые нужно связать с этой фигурой, и нажмите Вставить .

      При этом выбранные управляемые объекты добавляются в набор данных на диаграмме Visio, которую можно просмотреть в окне «Внешние данные».

    4. В окне «Внешние данные» выберите объект, который нужно соединить с фигурой на схеме или изображении.

      Например, если вы хотите добавить сервер управления для географического местоположения на карту, выберите сервер управления.

    5. Перетащите объект на диаграмму или изображение и поместите его на фигуру. Это устанавливает связь между фигурой и записью этого управляемого объекта.

    Автоматическая привязка нескольких фигур Visio к управляемым компьютерам и сетевым устройствам Operations Manager

    1. Откройте документ Visio.

      Убедитесь, что каждая фигура имеет определенные данные фигуры, такие как сетевое имя или IP-адрес, или текст фигуры (например, IP-адрес объекта).

      Чтобы просмотреть данные формы, щелкните фигуру правой кнопкой мыши, выберите Данные , а затем щелкните Данные формы . Это открывает окно данных формы для выбранной формы.

    2. Выделите все фигуры в документе.

    3. Щелкните Operations Manager на ленте, а затем щелкните Согласовать формы .

    4. В мастере автоматического связывания выберите Выбранные фигуры или Все фигуры в документе , а затем нажмите Далее .

    5. Сопоставьте свойство формы Visio со свойством объекта Operations Manager. Например, сопоставьте сетевое имя Visio с отображаемым именем объекта Operations Manager. Следующие классы Operations Manager сопоставляются автоматически:

      • Компьютер Windows (Microsoft.Windows.Computer)

      • Компьютер Unix (Microsoft.Unix.Computer)

      • Сетевое устройство SNMP (Microsoft.SystemCenter.NetworkDevice)

      Щелкните Далее .

    6. Просмотрите список совпадений. Щелкните, чтобы удалить объекты, которые вы не хотите связывать, а затем щелкните Далее .

      Если найдено более одного совпадения, нажмите Выбрать , чтобы выбрать объект, на который нужно установить ссылку. Если совпадений не найдено, щелкните Обзор для поиска объекта.

    7. Просмотрите список ссылок для определения и нажмите Готово .

    Фигуры автоматически подключаются к управляемым объектам, которые они представляют на сервере управления.

    Вставить фигуру, связанную с объектом Operations Manager

    1. На схеме Visio щелкните Operations Manager на ленте, а затем щелкните Вставить фигуру .

    2. Выберите класс объекта, который вы хотите вставить. Это фильтрует доступные объекты только для объектов указанного класса. Вы также можете искать конкретный объект.

    3. Выберите конкретный объект и нажмите Вставить .

    Новая форма добавлена ​​на диаграмму. Значок формы соответствует значку других объектов Operations Manager того же класса, а данные формы заполняются информацией из группы управления.

    Работа с документами - Изучение веб-разработки

    При написании веб-страниц и приложений одна из самых распространенных вещей, которые вы захотите сделать, - это каким-то образом манипулировать структурой документа. Обычно это делается с помощью объектной модели документа (DOM), набора API-интерфейсов для управления HTML и информацией о стилях, которые интенсивно используют объект Document .В этой статье мы подробно рассмотрим, как использовать DOM, а также некоторые другие интересные API, которые могут интересно изменить вашу среду.

    Предварительные требования: Базовая компьютерная грамотность, базовое понимание HTML, CSS и JavaScript, включая объекты JavaScript.
    Цель: Ознакомиться с основными API-интерфейсами DOM и другими API-интерфейсами, обычно связанными с DOM и манипуляциями с документами.

    Веб-браузеры - это очень сложные программы с множеством движущихся частей, многие из которых не могут контролироваться или управляться веб-разработчиком с помощью JavaScript.Вы можете подумать, что такие ограничения - это плохо, но браузеры заблокированы по уважительным причинам, в основном из-за безопасности. Представьте себе, если бы веб-сайт мог получить доступ к вашим сохраненным паролям или другой конфиденциальной информации и заходить на веб-сайты, как если бы это были вы?

    Несмотря на ограничения, веб-API по-прежнему предоставляют нам доступ ко многим функциям, которые позволяют нам многое делать с веб-страницами. Есть несколько действительно очевидных моментов, на которые вы будете регулярно ссылаться в своем коде - рассмотрите следующую диаграмму, которая представляет основные части браузера, непосредственно участвующие в просмотре веб-страниц:

    • Окно - это вкладка браузера, в которую загружается веб-страница; это представлено в JavaScript объектом Window .Используя методы, доступные для этого объекта, вы можете делать такие вещи, как возвращать размер окна (см. Window.innerWidth и Window.innerHeight ), управлять документом, загруженным в это окно, сохранять данные, относящиеся к этому документу, на стороне клиента ( например, используя локальную базу данных или другой механизм хранения), прикрепите обработчик событий к текущему окну и т. д.
    • Навигатор представляет состояние и идентичность браузера (то есть агента пользователя) в том виде, в каком он существует в сети.В JavaScript это представлено объектом Navigator . Вы можете использовать этот объект для получения таких вещей, как предпочитаемый язык пользователя, медиапоток с веб-камеры пользователя и т. Д.
    • Документ (представленный DOM в браузерах) является фактической страницей, загруженной в окно, и представлен в JavaScript объектом Document . Вы можете использовать этот объект для возврата и управления информацией в HTML и CSS, составляющих документ, например, для получения ссылки на элемент в DOM, изменения его текстового содержимого, применения к нему новых стилей, создания новых элементов и добавления их в текущий элемент как дочерний или даже удалить его полностью.

    В этой статье мы сосредоточимся в основном на работе с документом, но мы покажем еще несколько полезных моментов.

    Документ, загруженный в настоящее время на каждой из вкладок вашего браузера, представлен объектной моделью документа. Это представление «древовидной структуры», созданное браузером, которое позволяет легко получить доступ к структуре HTML для языков программирования - например, сам браузер использует его для применения стиля и другой информации к правильным элементам при отображении страницы, а разработчики например, вы можете управлять DOM с помощью JavaScript после того, как страница была отрисована.

    Мы создали простую страницу-пример по адресу dom-example.html (также см. Ее вживую). Попробуйте открыть это в своем браузере - это очень простая страница, содержащая элемент

    , внутри которого вы можете найти изображение, и абзац со ссылкой внутри. Исходный код HTML выглядит так:

      
    
      
        
         Простой пример DOM 
      
      
          <раздел>
             Красный тираннозавр Рекс: двуногий динозавр, стоящий прямо, как человек, с маленькими руками и большой головой с множеством острых зубов. 
            

    Здесь мы добавим ссылку на главную страницу Mozilla

    DOM, с другой стороны, выглядит так:

    Примечание : Эта древовидная диаграмма DOM была создана с помощью программы просмотра Live DOM Яна Хиксона.

    Здесь вы можете видеть, что каждый элемент и бит текста в документе имеет свою собственную запись в дереве - каждая из них называется узлом . Вы также встретите различные термины, используемые для описания типа узла и их положения в дереве по отношению друг к другу:

    • Узел элемента : элемент в том виде, в каком он существует в модели DOM.
    • Корневой узел : Верхний узел в дереве, который в случае HTML всегда является узлом HTML (другие словари разметки, такие как SVG и пользовательский XML, будут иметь другие корневые элементы).
    • Дочерний узел : узел непосредственно внутри другого узла. Например, IMG является дочерним элементом SECTION в приведенном выше примере.
    • Дочерний узел : узел в любом месте внутри другого узла. Например, IMG является дочерним элементом SECTION в приведенном выше примере, а также является потомком. IMG не является дочерним элементом BODY , поскольку он находится на два уровня ниже в дереве, но является потомком BODY .
    • Родительский узел : узел, внутри которого есть еще один узел. Например, BODY является родительским узлом SECTION в приведенном выше примере.
    • Узлы-братья : Узлы, которые находятся на одном уровне в дереве DOM. Например, IMG и P являются братьями и сестрами в приведенном выше примере.
    • Текстовый узел : Узел, содержащий текстовую строку.

    Перед работой с DOM полезно ознакомиться с этой терминологией, так как они используются в ряде терминов кода, с которыми вы столкнетесь.Вы также могли столкнуться с ними, если изучали CSS (например, селектор потомков, селектор потомков).

    Чтобы начать изучение манипуляций с DOM, давайте начнем с практического примера.

    1. Возьмите локальную копию страницы dom-example.html и изображения, сопровождающего ее.
    2. Добавьте элемент непосредственно над закрывающим тегом .
    3. Чтобы управлять элементом внутри DOM, вам сначала нужно выбрать его и сохранить ссылку на него внутри переменной.Внутри элемента сценария добавьте следующую строку:
        константная ссылка = document.querySelector ('a');  
    4. Теперь у нас есть ссылка на элемент, хранящаяся в переменной, мы можем начать манипулировать ею, используя доступные ей свойства и методы (они определены на таких интерфейсах, как HTMLAnchorElement в случае элемента , его более общего родительского элемента interface HTMLElement и Node - который представляет все узлы в DOM).Прежде всего, давайте изменим текст внутри ссылки, обновив значение свойства Node.textContent . Добавьте следующую строку под предыдущей:
        link.textContent = 'Сеть разработчиков Mozilla';  
    5. Мы также должны изменить URL-адрес, на который указывает ссылка, чтобы она не попадала в неправильное место при нажатии. Добавьте следующую строку снова внизу:
        link.href = 'https://developer.mozilla.org';  

    Обратите внимание, что, как и во многих других случаях в JavaScript, существует множество способов выбрать элемент и сохранить ссылку на него в переменной. Document.querySelector () - это рекомендуемый современный подход, который удобен, поскольку позволяет выбирать элементы с помощью селекторов CSS. Вышеупомянутый вызов querySelector () будет соответствовать первому элементу , который появляется в документе. Если вы хотите сопоставить несколько элементов и выполнить какие-либо действия с ними, вы можете использовать Document.querySelectorAll () , который соответствует каждому элементу в документе, который соответствует селектору, и сохраняет ссылки на них в подобном массиву объекте, называемом NodeList. .

    Для получения ссылок на элементы доступны более старые методы, например:

    Эти два метода работают лучше в старых браузерах, чем современные методы, такие как querySelector () , но не так удобны. Взгляните и посмотрите, что другие вы можете найти!

    Создание и размещение новых узлов

    Вышесказанное дало вам небольшое представление о том, что вы можете сделать, но давайте пойдем дальше и посмотрим, как мы можем создавать новые элементы.

    1. Возвращаясь к текущему примеру, давайте начнем с получения ссылки на наш элемент
      - добавьте следующий код в конец существующего скрипта (сделайте то же самое и с другими строками):
        const sect = document.querySelector ('раздел');  
    2. Теперь давайте создадим новый абзац с помощью Document.createElement () и дадим ему текстовое содержимое так же, как и раньше:
        const para = document.createElement ('p');
      para.textContent = 'Надеемся, вам понравилась поездка.';  
    3. Теперь вы можете добавить новый абзац в конец раздела, используя Node.appendChild () :
        раздел приложение «Ребенок» (пункт);  
    4. Наконец, для этой части давайте добавим текстовый узел к абзацу, внутри которого находится ссылка, чтобы красиво завершить предложение. Сначала мы создадим текстовый узел, используя Document.createTextNode () :
        const текст = документ.createTextNode ('- главный источник знаний о веб-разработке.');  
    5. Теперь мы возьмем ссылку на абзац, внутри которого находится ссылка, и добавим к нему текстовый узел:
        const linkPara = document.querySelector ('p');
      linkPara.appendChild (текст);  

    Это большая часть того, что вам нужно для добавления узлов в DOM - вы будете часто использовать эти методы при построении динамических интерфейсов (мы рассмотрим некоторые примеры позже).

    Перемещение и удаление элементов

    Бывают случаи, когда вы хотите переместить узлы или полностью удалить их из DOM.Это вполне возможно.

    Если бы мы хотели переместить абзац со ссылкой внутри него в нижнюю часть раздела, мы могли бы сделать это:

      sect.appendChild (linkPara);  

    Перемещает абзац в конец раздела. Вы могли подумать, что он сделает вторую копию этого абзаца, но это не так - linkPara - это ссылка на единственную копию этого абзаца. Если вы хотите сделать копию и добавить ее, вам понадобится Node.cloneNode () вместо этого.

    Удалить узел тоже довольно просто, по крайней мере, если у вас есть ссылка на удаляемый узел и его родительский элемент. В нашем текущем случае мы просто используем Node.removeChild () , например:

      sect.removeChild (linkPara);  

    Если вы хотите удалить узел, основываясь только на ссылке на него, что довольно часто встречается, вы можете использовать ChildNode.remove () :

      linkPara.remove ();  

    Этот метод не поддерживается в старых версиях браузеров.У них нет способа сказать узлу удалить себя, поэтому вам придется сделать следующее.

      linkPara.parentNode.removeChild (linkPara);  

    Попробуйте добавить указанные выше строки в свой код.

    Управление стилями

    Управлять стилями CSS с помощью JavaScript можно различными способами.

    Для начала вы можете получить список всех таблиц стилей, прикрепленных к документу, используя Document.stylesheets , который возвращает объект, подобный массиву, с объектами CSSStyleSheet .Затем вы можете добавлять / удалять стили по желанию. Однако мы не собираемся расширять эти функции, потому что они представляют собой несколько архаичный и сложный способ управления стилем. Есть гораздо более простые способы.

    Первый способ - добавить встроенные стили непосредственно к элементам, которые вы хотите динамически стилизовать. Это делается с помощью свойства HTMLElement.style , которое содержит встроенную информацию о стилях для каждого элемента в документе. Вы можете установить свойства этого объекта, чтобы напрямую обновлять стили элементов.

    1. В качестве примера попробуйте добавить эти строки в наш текущий пример:
        para.style.color = 'белый';
      para.style.backgroundColor = 'черный';
      para.style.padding = '10px';
      para.style.width = '250px';
      para.style.textAlign = 'центр';  
    2. Перезагрузите страницу, и вы увидите, что стили были применены к абзацу. Если вы посмотрите на этот абзац в инспекторе страниц / DOM вашего браузера, вы увидите, что эти строки действительно добавляют в документ встроенные стили:
        

      Надеемся, поездка вам понравилась.

    Примечание : Обратите внимание, как версии свойств JavaScript стилей CSS записываются в нижнем регистре верблюда, тогда как версии CSS переносятся через дефис (например, backgroundColor по сравнению с background-color ). Убедитесь, что вы не перепутали их, иначе ничего не получится.

    Существует еще один распространенный способ динамического управления стилями в вашем документе, который мы сейчас рассмотрим.

    1. Удалите предыдущие пять строк, которые вы добавили в JavaScript.
    2. Добавьте в HTML-код следующее:
       <стиль>
      .выделять {
        цвет белый;
        цвет фона: черный;
        отступ: 10 пикселей;
        ширина: 250 пикселей;
        выравнивание текста: центр;
      }
       
    3. Теперь мы обратимся к очень полезному методу для общих манипуляций с HTML - Element.setAttribute () - он принимает два аргумента: атрибут, который вы хотите установить для элемента, и значение, которое вы хотите установить. В этом случае мы установим имя класса для выделения в нашем абзаце:
        пункт.setAttribute ('класс', 'выделение');  
    4. Обновите страницу, и вы не увидите никаких изменений - CSS по-прежнему применяется к абзацу, но на этот раз путем присвоения ему класса, который выбирается нашим правилом CSS, а не встроенными стилями CSS.

    Какой метод выбрать, зависит от вас; у обоих есть свои преимущества и недостатки. Первый метод требует меньше настроек и подходит для простого использования, тогда как второй метод более пуристичен (без смешивания CSS и JavaScript, без встроенных стилей, что считается плохой практикой).Когда вы начнете создавать более крупные и более сложные приложения, вы, вероятно, начнете больше использовать второй метод, но это действительно зависит от вас.

    На данный момент мы действительно не сделали ничего полезного! Нет смысла использовать JavaScript для создания статического контента - вы можете просто записать его в свой HTML и не использовать JavaScript. Он сложнее, чем HTML, и создание вашего контента с помощью JavaScript также связано с другими проблемами (например, его нечитают поисковые системы).

    В следующих нескольких разделах мы рассмотрим еще несколько практических применений DOM API.

    До сих пор мы только рассматривали использование функций узла Node и Document для управления документами, но нет причин, по которым вы не можете получить данные из других источников и использовать их в своем пользовательском интерфейсе. Вам просто нужно убедиться, что ваши данные находятся в правильном формате; JavaScript делает его проще, чем многие другие языки, поскольку он слабо типизирован - например, числа автоматически преобразуются в строки, когда вы хотите вывести их на экран.

    В этом примере мы решим общую проблему - убедимся, что размер вашего приложения равен размеру окна, в котором оно просматривается, независимо от его размера.Это часто бывает полезно в таких ситуациях, как игры, где вы хотите использовать как можно большую часть экрана для игры.

    Для начала сделайте локальную копию наших демонстрационных файлов window-resize-example.html и bgtile.png. Откройте его и посмотрите - вы увидите, что у нас есть элемент

    , покрывающий небольшую часть экрана, к которому применена фоновая плитка. Мы будем использовать это для представления области пользовательского интерфейса нашего приложения.

    1. Прежде всего, давайте возьмем ссылку на div, а затем возьмем ширину и высоту области просмотра (внутреннее окно, в котором отображается ваш документ) и сохраним их в переменных - эти два значения легко содержатся в Окно.innerWidth и Window.innerHeight свойства. Добавьте следующие строки в существующий элемент
      путей:
      /Погода:
        получать:
          теги:
          - Текущие данные о погоде
          Резюме: "Вызов текущих данных о погоде для одного места."
          описание: «Доступ к текущим данным о погоде для любого места на Земле, включая более 200 000 городов! Текущая погода часто обновляется на основе глобальных моделей и данных с более чем 40 000 метеостанций».
          operationId: CurrentWeatherData
          параметры:
          - имя: q
            в: запрос
            description: "** Название города **.  * Пример: Лондон *. Вы можете позвонить по названию города или по названию города и коду страны. API отвечает списком результатов, которые соответствуют поисковому слову. Для значения запроса, введите название города и, при желании, код страны, разделенный запятой; используйте коды стран ISO 3166."
            схема:
              тип: строка
    
          - имя: id
            в: запрос
            description: "** ID города **. * Пример:` 2172797` *. Вы можете позвонить по ID города. API вернет точный результат. Список идентификаторов городов можно скачать [здесь] (http: // bulk .openweathermap.org / sample /). В этот параметр можно включить несколько городов & mdash; просто разделите их запятыми. Максимальное количество местоположений - 20. * Примечание. Один идентификатор считается одним вызовом API. Итак, если у вас есть идентификаторы городов, это рассматривается как 3 вызова API.* "
            схема:
              тип: строка
    
          - название: лат
            в: запрос
            description: "** Широта **. * Пример: 35 *. Координата широты интересующего вас местоположения. Необходимо использовать с` lon`. "
            схема:
              тип: строка
    
          - имя: lon
            в: запрос
            description: "** Долгота **. * Пример: 139 *. Координата долготы интересующего вас места. Необходимо использовать вместе с` lat`. "
            схема:
              тип: строка
    
          - название: zip
            в: запрос
            описание: «** Почтовый индекс **.Поиск по почтовому индексу. * Пример: , США *. Обратите внимание, что если страна не указана, поиск по умолчанию использует США ».
            схема:
              тип: строка
    
          - название: единицы
            в: запрос
            описание: '** Единицы **. * Пример: британская *. Возможные значения: standard, metric и imperial. Когда вы не используете параметр «units», по умолчанию используется «стандартный» формат.
            схема:
              тип: строка
              enum: [стандартный, метрический, британский]
              по умолчанию: "имперский"
    
          - имя: lang
            в: запрос
            описание: '** Язык **. * Пример: en *. Вы можете использовать параметр lang, чтобы получить вывод на вашем языке. Мы поддерживаем следующие языки, которые можно использовать с соответствующими значениями lang: арабский - `ar`, болгарский -` bg`, каталонский - `ca`, чешский -` cz`, немецкий - `de`, греческий -` el` , Английский - `en`, персидский (фарси) -` fa`, финский - `fi`, французский -` fr`, галисийский - `gl`, хорватский -` hr`, венгерский - `hu`, итальянский -` it `, Японский -` ja`, корейский - `kr`, латышский -` la`, литовский - `lt`, македонский -` mk`, голландский - `nl`, польский -` pl`, португальский - `pt`, Румынский - `ro`, русский -` ru`, шведский - `se`, словацкий -` sk`, словенский - `sl`, испанский -` es`, турецкий - `tr`, украинский -` ua`, вьетнамский - vi, упрощенный китайский - zh_cn, традиционный китайский - zh_tw.'
            схема:
              тип: строка
              перечисление: [ar, bg, ca, cz, de, el, en, fa, fi, fr, gl, hr, hu, it, ja, kr, la, lt, mk, nl, pl, pt, ro, ru , se, sk, sl, es, tr, ua, vi, zh_cn, zh_tw]
              по умолчанию: "en"
    
          - название: режим
            в: запрос
            description: «** Mode **. * Пример: html *. Определяет формат ответа. Возможные значения:` xml` и `html`. Если параметр режима пуст, по умолчанию используется формат` json`. "
            схема:
              тип: строка
              перечисление: [json, xml, html]
              по умолчанию: "json"
      

    Операции с объектами - Документация Ceph

    ListPartsResult

    Контейнер

    Контейнер для результатов.

    Ковш

    Строка

    Корзина, которая получит содержимое объекта.

    Ключ

    Строка

    Ключ, указанный параметром запроса key (если есть).

    UploadId

    Строка

    ID, указанный параметром запроса upload-id , идентифицирующим составную выгрузку (если есть).

    Инициатор

    Контейнер

    Содержит ID и DisplayName пользователя, инициировавшего загрузку.

    ID

    Строка

    ID инициатора.

    DisplayName

    Строка

    Отображаемое имя инициатора.

    Владелец

    Контейнер

    Контейнер для ID и DisplayName пользователя, которому принадлежит загруженный объект.

    Класс хранения

    Строка

    Метод, используемый для хранения результирующего объекта. СТАНДАРТ или СОКРАЩЕННЫЙ_ЗАВИСИМОСТЬ

    Маркер номера детали

    Строка

    Маркер детали для использования в последующем запросе, если IsTruncated равен true .Перед списком.

    NextPartNumberMarker

    Строка

    Маркер следующей части для использования в последующем запросе, если IsTruncated равен true . Конец списка.

    MaxParts

    Целое

    Максимальное количество частей, разрешенных в ответе, как указано в параметре запроса max-parts .

    IsTruncated

    логический

    Если истинно , была возвращена только часть загруженного содержимого объекта.

    Деталь

    Контейнер

    Контейнер для элементов LastModified , PartNumber , ETag и Размер элементов.

    LastModified

    Дата

    Дата и время загрузки детали.

    Номер детали

    Целое

    Идентификационный номер детали.

    ETag

    Строка

    Тег объекта детали.

    Размер

    Целое

    Размер загружаемой части.

    S3 - Документы Boto3 1.Документация 17.48

    Извлекает объекты из Amazon S3. Чтобы использовать GET, у вас должен быть доступ на ЧТЕНИЕ к объекту. Если вы предоставите доступ READ анонимному пользователю, вы можете вернуть объект без использования заголовка авторизации.

    Корзина Amazon S3 не имеет иерархии каталогов, как в обычной файловой системе компьютера. Однако вы можете создать логическую иерархию, используя имена ключей объектов, которые подразумевают структуру папок. Например, вместо названия объекта sample.jpg, можете называть его photos / 2006 / February / sample.jpg.

    Чтобы получить объект из такой логической иерархии, укажите полное имя ключа для объекта в операции GET. Для примера запроса в виртуальном размещенном стиле, если у вас есть объект photos / 2006 / February / sample.jpg, укажите ресурс как /photos/2006/Feb February/sample.jpg. В качестве примера запроса стиля пути, если у вас есть объект photos / 2006 / February / sample.jpg в корзине с именем examplebucket, укажите ресурс как / examplebucket / photos / 2006 / February / sample.jpg. Дополнительные сведения о типах запросов см. В разделе «Спецификация сегмента заголовка узла HTTP».

    Чтобы распространять большие файлы среди множества людей, вы можете сэкономить на полосе пропускания с помощью BitTorrent. Для получения дополнительной информации см. Amazon S3 Torrent. Дополнительные сведения о возврате ACL объекта см. В GetObjectAcl.

    Если извлекаемый объект хранится в классе хранилища S3 Glacier или S3 Glacier Deep Archive, или на уровнях S3 Intelligent-Tiering Archive или S3 Intelligent-Tiering Deep Archive, перед извлечением объекта необходимо сначала восстановить копию с помощью RestoreObject. .В противном случае это действие возвращает ошибку InvalidObjectStateError. Для получения информации о восстановлении заархивированных объектов см. Восстановление заархивированных объектов.

    Заголовки запроса шифрования, такие как x-amz-server-side-encryption, не должны отправляться для GET-запросов, если ваш объект использует шифрование на стороне сервера с помощью CMK, хранящихся в AWS KMS (SSE-KMS), или шифрование на стороне сервера с Amazon S3. –Управляемые ключи шифрования (SSE-S3). Если ваш объект действительно использует эти типы ключей, вы получите ошибку HTTP 400 BadRequest.

    Если вы зашифруете объект с помощью серверного шифрования с помощью ключей шифрования, предоставленных клиентом (SSE-C), когда вы храните объект в Amazon S3, то при ПОЛУЧЕНИИ объекта вы должны использовать следующие заголовки:

    • алгоритм шифрования на стороне сервера x-amz
    • x-amz-сервер-шифрование-клиент-ключ
    • x-amz-сервер-шифрование-ключ-клиента-MD5

    Дополнительные сведения о SSE-C см. В разделе Шифрование на стороне сервера (с использованием ключей шифрования, предоставленных заказчиком).

    Предполагая, что у вас есть разрешение на чтение тегов объекта (разрешение для действия s3: GetObjectVersionTagging), ответ также возвращает заголовок x-amz-tagging-count, который обеспечивает подсчет количества тегов, связанных с объектом. Вы можете использовать GetObjectTagging для получения набора тегов, связанного с объектом.

    Разрешения

    Для этой операции вам потребуется разрешение s3: GetObject. Для получения дополнительной информации см. Определение разрешений в политике. Если запрашиваемый объект не существует, ошибка, которую возвращает Amazon S3, зависит от того, есть ли у вас разрешение s3: ListBucket.

    • Если у вас есть разрешение s3: ListBucket для корзины, Amazon S3 вернет ошибку с кодом состояния HTTP 404 («нет такого ключа»).
    • Если у вас нет разрешения s3: ListBucket, Amazon S3 вернет ошибку с кодом состояния HTTP 403 («доступ запрещен»).

    Управление версиями

    По умолчанию действие GET возвращает текущую версию объекта.Чтобы вернуть другую версию, используйте подресурс versionId.

    Примечание

    Если текущая версия объекта является маркером удаления, Amazon S3 ведет себя так, как если бы объект был удален, и включает в ответ x-amz-delete-marker: true.

    Для получения дополнительной информации об управлении версиями см. PutBucketVersioning.

    Отмена значений заголовка ответа

    Бывают случаи, когда вы хотите переопределить определенные значения заголовка ответа в ответе GET.Например, вы можете переопределить значение заголовка ответа Content-Disposition в своем запросе GET.

    Вы можете переопределить значения для набора заголовков ответов, используя следующие параметры запроса. Эти значения заголовка ответа отправляются только при успешном запросе, то есть когда возвращается код состояния 200 OK. Набор заголовков, которые вы можете переопределить с помощью этих параметров, представляет собой подмножество заголовков, которые Amazon S3 принимает при создании объекта. Заголовки ответа, которые можно переопределить для ответа GET, - это Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition и Content-Encoding.Чтобы переопределить эти значения заголовка в ответе GET, используйте следующие параметры запроса.

    Примечание

    При использовании этих параметров необходимо подписать запрос, используя заголовок авторизации или заранее подписанный URL. Их нельзя использовать с неподписанным (анонимным) запросом.

    • тип содержимого ответа
    • язык-содержимого-ответа
    • срок действия ответа
    • контроль кэша ответов
    • ответ-содержание-расположение
    • кодирование содержимого ответа

    Дополнительные сведения о заголовках запросов

    Если оба заголовка If-Match и If-Unmodified-Since присутствуют в запросе следующим образом: Условие If-Match оценивается как истинное, и; Условие If-Unmodified-Since оценивается как ложное; затем S3 возвращает 200 OK и запрошенные данные.

    Если оба заголовка If-None-Match и If-Modified-Since присутствуют в запросе следующим образом: Условие If-None-Match оценивается как ложное, и; Условие If-Modified-Since оценивается как истинное; затем S3 возвращает код ответа 304 Not Modified.

    Дополнительные сведения об условных запросах см. В RFC 7232.

    С GetObject связаны следующие операции:

    См. Также: Документация по API AWS

    Синтаксис запроса

     ответ = клиент.get_object (
        Bucket = 'строка',
        IfMatch = 'строка',
        IfModifiedSince = datetime (2015, 1, 1),
        IfNoneMatch = 'строка',
        IfUnmodifiedSince = datetime (2015, 1, 1),
        Ключ = 'строка',
        Диапазон = 'строка',
        ResponseCacheControl = 'строка',
        ResponseContentDisposition = 'строка',
        ResponseContentEncoding = 'строка',
        ResponseContentLanguage = 'строка',
        ResponseContentType = 'строка',
        ResponseExpires = datetime (2015, 1, 1),
        VersionId = 'строка',
        SSECustomerAlgorithm = 'строка',
        SSECustomerKey = 'строка',
        RequestPayer = 'запрашивающий',
        PartNumber = 123,
        ExpectedBucketOwner = 'строка'
    )
     
    Параметры
    • Ковш ( строка ) -

      [ТРЕБУЕТСЯ]

      Имя сегмента, содержащего объект.

      При использовании этого действия с точкой доступа вы должны направлять запросы к имени хоста точки доступа. Имя хоста точки доступа имеет вид AccessPointName - AccountId .s3-accesspoint. * Регион * .amazonaws.com. При использовании этого действия с точкой доступа через пакеты SDK AWS вы указываете ARN точки доступа вместо имени корзины. Дополнительные сведения о точках доступа ARN см. В разделе Использование точек доступа в Руководстве пользователя Amazon S3 .

      При использовании этого действия с Amazon S3 на Outposts вы должны направлять запросы на имя хоста S3 on Outposts.Имя хоста S3 на Outposts имеет вид AccessPointName - AccountId . * OutpostID * .s3-outposts. * Region * .amazonaws.com. При использовании этого действия с помощью S3 на Outposts через пакеты SDK AWS вы предоставляете ARN корзины Outposts вместо имени корзины. Дополнительные сведения о S3 на Outposts ARN см. В разделе Использование S3 на Outposts в Руководстве пользователя Amazon S3 .

    • IfMatch ( строка ) - возвращать объект только в том случае, если его тег объекта (ETag) совпадает с указанным, в противном случае вернуть 412 (предварительное условие не выполнено).
    • IfModifiedSince ( datetime ) - вернуть объект, только если он был изменен с указанного времени, в противном случае вернуть 304 (не изменено).
    • IfNoneMatch ( строка ) - возвращать объект только в том случае, если его тег объекта (ETag) отличается от указанного, в противном случае возвращается 304 (не изменено).
    • IfUnmodifiedSince ( datetime ) - вернуть объект, только если он не был изменен с указанного времени, в противном случае вернуть 412 (предварительное условие не выполнено).
    • Ключ ( строка ) -

      [ТРЕБУЕТСЯ]

      Ключ объекта, который нужно получить.

    • Диапазон ( строка ) -

      Загружает указанный диапазон байтов объекта. Для получения дополнительной информации о заголовке HTTP Range см. Https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

      Примечание

      Amazon S3 не поддерживает получение нескольких диапазонов данных за один запрос GET.

    • ResponseCacheControl ( строка ) - устанавливает заголовок ответа Cache-Control.
    • ResponseContentDisposition ( строка ) - устанавливает заголовок Content-Disposition для ответа
    • ResponseContentEncoding ( строка ) - устанавливает заголовок Content-Encoding ответа.
    • ResponseContentLanguage ( строка ) - устанавливает заголовок Content-Language ответа.
    • ResponseContentType ( строка ) - устанавливает заголовок Content-Type ответа.
    • ResponseExpires ( datetime ) - устанавливает заголовок Expires ответа.
    • VersionId ( строка ) - VersionId, используемый для ссылки на определенную версию объекта.
    • SSECustomerAlgorithm ( строка ) - указывает алгоритм, который будет использоваться при расшифровке объекта (например, AES256).
    • SSECustomerKey ( строка ) - указывает предоставленный клиентом ключ шифрования для Amazon S3, используемый для шифрования данных.Это значение используется для расшифровки объекта при его восстановлении и должно соответствовать тому, которое использовалось при сохранении данных. Ключ должен подходить для использования с алгоритмом, указанным в заголовке x-amz-server-side-encryption-customer-algorithm.
    • SSECustomerKeyMD5 ( строка ) -

      Задает 128-битный MD5 дайджест ключа шифрования в соответствии с RFC 1321. Amazon S3 использует этот заголовок для проверки целостности сообщения, чтобы гарантировать, что ключ шифрования был передан без ошибок.

      Обратите внимание, что этот параметр заполняется автоматически, если он не указан. Включение этого параметра не требуется

    • RequestPayer ( строка ) - подтверждает, что запрашивающая сторона знает, что с него будет взиматься плата за запрос. Владельцам корзин не нужно указывать этот параметр в своих запросах. Информацию о загрузке объектов из корзин "запрашивающая сторона платит" см. В разделе "Загрузка объектов в корзинах оплаты запрашивающей стороны" в Руководстве для разработчиков Amazon S3 .
    • PartNumber ( целое число ) - порядковый номер считываемого объекта. Это положительное целое число от 1 до 10 000. Эффективно выполняет «ранжированный» запрос GET для указанной части. Полезно для скачивания только части объекта.
    • ExpectedBucketOwner ( строка ) - идентификатор учетной записи предполагаемого владельца корзины. Если корзина принадлежит другой учетной записи, запрос завершится ошибкой HTTP 403 (доступ запрещен).
    Тип возврата

    dict

    Возвращает

    Синтаксис ответа

     {
        'Body': StreamingBody (),
        'DeleteMarker': True | False,
        'AcceptRanges': 'строка',
        'Срок действия': 'строка',
        'Восстановить': 'строка',
        LastModified: datetime (2015, 1, 1),
        ContentLength: 123,
        'ETag': 'строка',
        'MissingMeta': 123,
        'VersionId': 'строка',
        'CacheControl': 'строка',
        'ContentDisposition': 'строка',
        'ContentEncoding': 'строка',
        'ContentLanguage': 'строка',
        'ContentRange': 'строка',
        'ContentType': 'строка',
        'Истекает': datetime (2015, 1, 1),
        'WebsiteRedirectLocation': 'строка',
        'ServerSideEncryption': 'AES256' | 'aws: kms',
        'Метаданные': {
            'строка': 'строка'
        },
        'SSECustomerAlgorithm': 'строка',
        'SSECustomerKeyMD5': 'строка',
        'SSEKMSKeyId': 'строка',
        'BucketKeyEnabled': Истина | Ложь,
        'StorageClass': 'STANDARD' | 'REDUCED_REDUNDANCY' | 'STANDARD_IA' | 'ONEZONE_IA' | 'INTELLIGENT_TIERING' | 'GLACIER' | 'DEEP_ARCHIVE' | 'OUTPOSTS',
        'RequestCharged': 'запросчик',
        'ReplicationStatus': 'COMPLETE' | 'PENDING' | 'FAILED' | 'REPLICA',
        'PartsCount': 123,
        'TagCount': 123,
        'ObjectLockMode': 'УПРАВЛЕНИЕ' | 'СОБЛЮДЕНИЕ',
        'ObjectLockRetainUntilDate': datetime (2015, 1, 1),
        'ObjectLockLegalHoldStatus': 'ВКЛ' | 'ВЫКЛ'
    }
     

    Структура ответа

    • (дикт) -

      • Кузов (StreamingBody) -

        Данные объекта.

      • DeleteMarker (логический) -

        Указывает, был ли полученный объект (true) или нет (false) маркером удаления. Если false, этот заголовок ответа не появляется в ответе.

      • AcceptRanges (строка) -

        Указывает, что указан диапазон байтов.

      • Срок годности (строка) -

        Если срок действия объекта настроен (см. Жизненный цикл сегмента PUT), ответ включает этот заголовок.Он включает пары «ключ-значение» с датой истечения срока действия и идентификатором правила, предоставляющие информацию об истечении срока действия объекта. Значение идентификатора правила закодировано в URL.

      • Восстановить (строка) -

        Предоставляет информацию о действии восстановления объекта и сроке действия восстановленной копии объекта.

      • LastModified (datetime) -

        Дата создания объекта.

      • ContentLength (целое число) -

        Размер тела в байтах.

      • ETag (строка) -

        ETag - это непрозрачный идентификатор, назначаемый веб-сервером определенной версии ресурса, найденного по URL-адресу.

      • MissingMeta (целое число) -

        Устанавливается на количество записей метаданных, не возвращаемых в заголовках x-amz-meta. Это может произойти, если вы создаете метаданные с помощью API, такого как SOAP, который поддерживает более гибкие метаданные, чем REST API. Например, с помощью SOAP вы можете создавать метаданные, значения которых не являются допустимыми заголовками HTTP.

      • VersionId (строка) -

        Версия объекта.

      • CacheControl (строка) -

        Задает поведение кэширования в цепочке запросов / ответов.

      • ContentDisposition (строка) -

        Задает презентационную информацию для объекта.

      • ContentEncoding (строка) -

        Указывает, какие кодировки контента были применены к объекту и, следовательно, какие механизмы декодирования должны применяться для получения медиа-типа, на который ссылается поле заголовка Content-Type.

      • ContentLanguage (строка) -

        Язык, на котором написано содержимое.

      • ContentRange (строка) -

        Часть объекта, возвращенная в ответе.

      • ContentType (строка) -

        Стандартный тип MIME, описывающий формат данных объекта.

      • Срок действия истекает (дата и время) -

        Дата и время, когда объект больше не кэшируется.

      • WebsiteRedirectLocation (строка) -

        Если сегмент настроен как веб-сайт, перенаправляет запросы для этого объекта на другой объект в том же сегменте или на внешний URL-адрес. Amazon S3 сохраняет значение этого заголовка в метаданных объекта.

      • ServerSideEncryption (строка) -

        Алгоритм шифрования на стороне сервера, используемый при хранении этого объекта в Amazon S3 (например, AES256, aws: kms).

      • Метаданные (dict) -

        Карта метаданных для хранения с объектом в S3.

      • SSECustomerAlgorithm (строка) -

        Если было запрошено шифрование на стороне сервера с предоставленным клиентом ключом шифрования, ответ будет включать этот заголовок, подтверждающий используемый алгоритм шифрования.

      • SSECustomerKeyMD5 (строка) -

        Если было запрошено шифрование на стороне сервера с предоставленным клиентом ключом шифрования, ответ будет включать этот заголовок для обеспечения проверки целостности сообщения в оба конца для предоставленного клиентом ключа шифрования.

      • SSEKMSKeyId (строка) -

        Если присутствует, указывает идентификатор симметричного главного ключа клиента (CMK) AWS Key Management Service (AWS KMS), который использовался для объекта.

      • BucketKeyEnabled (логическое) -

        Указывает, использует ли объект ключ сегмента S3 для шифрования на стороне сервера с помощью AWS KMS (SSE-KMS).

      • StorageClass (строка) -

        Предоставляет информацию о классе хранения объекта.Amazon S3 возвращает этот заголовок для всех объектов, кроме объектов класса хранилища S3 Standard.

      • RequestCharged (строка) -

        Если присутствует, указывает, что запрашивающая сторона успешно оплатила запрос.

      • ReplicationStatus (строка) -

        Amazon S3 может вернуть это, если ваш запрос включает корзину, которая является либо источником, либо местом назначения в правиле репликации.

      • PartsCount (целое число) -

        Количество частей этого объекта.

      • TagCount (целое число) -

        Количество тегов, если они есть, на объекте.

      • ObjectLockMode (строка) -

        Текущий режим блокировки объекта для этого объекта.

      • ObjectLockRetainUntilDate (datetime) -

        Дата и время истечения срока действия блокировки объекта.

      • ObjectLockLegalHoldStatus (строка) -

        Указывает, имеет ли этот объект активное юридическое удержание.Это поле возвращается только в том случае, если у вас есть разрешение на просмотр статуса юридического удержания объекта.

    Исключения

    • S3. Client.exceptions.NoSuchKey
    • S3.Client.exceptions.InvalidObjectState

    Примеры

    В следующем примере извлекается объект для корзины S3.

     response = client.get_object (
        Bucket = 'examplebucket',
        Key = 'HappyFace.jpg',
    )
    
    печать (ответ)
     

    Ожидаемый результат:

     {
        'AcceptRanges': 'байты',
        ContentLength: 3191,
        'ContentType': 'изображение / jpeg',
        'ETag': '"6805f2cfc46c0f04559748bb039d69ae"',
        'LastModified': datetime (2016, 12, 15, 1, 19, 41, 3, 350, 0),
        'Метаданные': {
        },
        'TagCount': 2,
        'VersionId': 'ноль',
        'ResponseMetadata': {
            '... ':' ... ',
        },
    }
     

    В следующем примере извлекается объект для корзины S3. В запросе указывается заголовок диапазона для получения определенного диапазона байтов.

     response = client.get_object (
        Bucket = 'examplebucket',
        Ключ = 'SampleFile.txt',
        Диапазон = 'байты = 0-9',
    )
    
    печать (ответ)
     

    Ожидаемый результат:

     {
        'AcceptRanges': 'байты',
        'ContentLength': '10',
        'ContentRange': 'байты 0-9 / 43',
        'ContentType': 'текст / простой',
        'ETag': '"0dffd0bc68cd3d152506b97a9cc"',
        'LastModified': datetime (2014, 10, 9, 22, 57, 28, 3, 282, 0),
        'Метаданные': {
        },
        'VersionId': 'ноль',
        'ResponseMetadata': {
            '... ':' ... ',
        },
    }
     

    OpenAPI-Specification / 2.0.md at master · OAI / OpenAPI-Specification · GitHub

    (fka Swagger RESTful API Documentation Specification)

    (Спецификация документации API Swagger RESTful)
    Версия 2.0

    Ключевые слова «ДОЛЖЕН», «НЕ ДОЛЖЕН», «ТРЕБУЕТСЯ», «ДОЛЖЕН», «НЕ ДОЛЖЕН», «ДОЛЖЕН», «НЕ ДОЛЖЕН», «РЕКОМЕНДУЕТСЯ», «МОЖЕТ» и «НЕОБЯЗАТЕЛЬНО» в этом документе. должны интерпретироваться, как описано в RFC 2119.

    Спецификация Swagger находится под лицензией Apache License, версия 2.0.

    Представления

    Swagger ™ - это проект, используемый для описания и документирования RESTful API.

    Спецификация Swagger определяет набор файлов, необходимых для описания такого API. Эти файлы затем могут использоваться проектом Swagger-UI для отображения API и Swagger-Codegen для создания клиентов на разных языках. Дополнительные утилиты также могут использовать полученные файлы, например инструменты тестирования.

    История изменений

    Версия Дата Банкноты
    2.0 08.09.2014 Выпуск Swagger 2.0
    1,2 2014-03-14 Первый выпуск официального документа.
    1,1 22.08.2012 Выпуск Swagger 1.1
    1,0 10.08.2011 Первый выпуск спецификации Swagger

    Определения

    Шаблон пути

    Шаблон пути означает использование фигурных скобок ({}) для пометки части пути URL как заменяемой с использованием параметров пути.

    Типы пантомимы

    Определения Mime-типов распределены по нескольким ресурсам. Определения MIME-типов должны соответствовать RFC 6838.

    Некоторые примеры возможных определений MIME-типов:

      текст / простой; charset = utf-8
      приложение / json
      приложение / vnd.github + json
      приложение / vnd.github.v3 + json
      приложение / vnd.github.v3.raw + json
      приложение / vnd.github.v3.text + json
      приложение / vnd.github.v3.html + json
      приложение / vnd.github.v3.full + json
      приложение / vnd.github.v3.diff
      application / vnd.github.v3.patch
      
    Коды состояния HTTP

    Коды состояния HTTP используются для обозначения состояния выполненной операции. Доступные коды состояния описаны в RFC 7231 и в Реестре кодов состояния IANA.

    Спецификация

    Формат

    Файлы, описывающие RESTful API в соответствии со спецификацией Swagger, представлены как объекты JSON и соответствуют стандартам JSON. YAML, являясь надмножеством JSON, также может использоваться для представляют файл спецификации Swagger.

    Например, если считается, что поле имеет значение массива, будет использоваться представление массива JSON:

    Хотя API описывается с использованием JSON, он не требует ввода / вывода JSON для самого API.

    Все имена полей в спецификации чувствительны к регистру .

    Схема предоставляет два типа полей. Фиксированные поля с объявленным именем и шаблонные поля, которые объявляют шаблон регулярного выражения для имени поля. Шаблонные поля могут иметь несколько экземпляров, если каждое имеет уникальное имя.

    Структура файла

    Swagger-представление API состоит из одного файла. Однако части определений могут быть разделены на отдельные файлы по усмотрению пользователя. Это применимо для полей $ ref в спецификации, как следует из определений схемы JSON.

    По соглашению файл спецификации Swagger называется swagger.json .

    Типы данных

    Примитивные типы данных в спецификации Swagger основаны на типах, поддерживаемых JSON-Schema Draft 4.Модели описываются с помощью объекта схемы, который является подмножеством проекта 4 схемы JSON.

    Дополнительный примитивный тип данных «файл» используется объектом параметра и объектом ответа для установки типа параметра или ответа как файла.

    Примитивы

    имеют необязательное свойство модификатора формата . Swagger использует несколько известных форматов для более точного определения используемого типа данных. Однако свойство формата - это открытая строка со значением и может иметь любое значение для поддержки документации.Такие форматы, как «email» , «uuid» и т. Д., Могут использоваться, даже если они не определены в данной спецификации. Типы, которые не сопровождаются свойством формата , следуют своему определению из схемы JSON (за исключением типа файла , который определен выше). Форматы, определенные в спецификации Swagger:

    Общее название тип формат Комментарии
    целое число целое внутр32 32 бита со знаком
    длинный целое внутр64 64 бита со знаком
    поплавок номер поплавок
    двойной номер двойной
    строка строка
    байт строка байт символов в кодировке base64
    двоичный строка двоичный любая последовательность октетов
    логический логическое
    дата строка дата Согласно определению полная дата - RFC3339
    дата и время строка дата и время Согласно определению дата-время - RFC3339
    пароль строка пароль Используется для подсказки пользовательскому интерфейсу, что ввод необходимо скрыть.

    Схема

    Объект Swagger

    Это объект корневого документа для спецификации API. Он объединяет то, что раньше было списком ресурсов и декларацией API (версия 1.2 и ранее), в один документ.

    Фиксированные поля
    Имя поля Тип Описание
    чванство строка Обязательно. Задает используемую версию спецификации Swagger. Он может использоваться пользовательским интерфейсом Swagger и другими клиентами для интерпретации списка API. Значение ДОЛЖНО быть "2,0" .
    информация Информационный объект Обязательно. Предоставляет метаданные об API. При необходимости клиенты могут использовать метаданные.
    хост строка Хост (имя или IP), обслуживающий API. Он ДОЛЖЕН быть только хостом и не включает ни схему, ни подпути.Он МОЖЕТ включать порт. Если хост не включен, должен использоваться хост, обслуживающий документацию (включая порт). Хост не поддерживает создание шаблонов пути.
    basePath строка Базовый путь, по которому обслуживается API, относительно хоста . Если он не включен, API обслуживается непосредственно хостом . Значение ДОЛЖНО начинаться с ведущей косой черты (/). basePath не поддерживает создание шаблонов пути.
    схемы [ строка ] Протокол передачи API. Значения ДОЛЖНЫ быть из списка: «http» , «https» , «ws» , «wss» . Если схемы не включены, по умолчанию будет использоваться схема, используемая для доступа к самому определению Swagger.
    потребляет [ строка ] Список типов MIME, которые могут использовать API.Это глобально для всех API, но может быть отменено для определенных вызовов API. Значение ДОЛЖНО быть таким, как описано в разделе "Типы MIME".
    производит [ строка ] Список типов MIME, которые могут создавать API. Это глобально для всех API, но может быть отменено для определенных вызовов API. Значение ДОЛЖНО быть таким, как описано в разделе Типы Mime.
    дорожек Путь, объект Обязательно. Доступные пути и операции для API.
    определения Объект определений Объект для хранения типов данных, созданных и потребляемых операциями.
    параметры Объект определения параметров Объект для хранения параметров, которые могут использоваться во всех операциях. Это свойство не определяет глобальные параметры для всех операций.
    ответов Ответы Определения Объект Объект для хранения ответов, которые можно использовать во всех операциях.Это свойство не определяет глобальные ответы для всех операций.
    безопасность Определения Объект определений безопасности Определения схемы безопасности, которые могут использоваться в спецификации.
    безопасность [Объект требований безопасности] Объявление того, какие схемы безопасности применяются для API в целом. Список значений описывает альтернативные схемы безопасности, которые можно использовать (то есть между требованиями безопасности существует логическое ИЛИ).Отдельные операции могут отменять это определение.
    теги [Тег объекта] Список тегов, используемых в спецификации, с дополнительными метаданными. Порядок тегов можно использовать для отражения их порядка с помощью инструментов синтаксического анализа. Не все теги, которые используются объектом операции, должны быть объявлены. Необъявленные теги могут быть организованы случайным образом или на основе логики инструментов. Каждое имя тега в списке ДОЛЖНО быть уникальным.
    внешние документы Объект внешней документации Дополнительная внешняя документация.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Информационный объект

    Объект предоставляет метаданные об API. При необходимости метаданные могут использоваться клиентами и для удобства могут быть представлены в пользовательском интерфейсе Swagger.

    Фиксированные поля
    Имя поля Тип Описание
    титул строка Обязательно. Название приложения.
    описание строка Краткое описание приложения. Синтаксис GFM можно использовать для форматированного текстового представления.
    Условия обслуживания строка Условия использования API.
    контакт Контактный объект Контактная информация для открытого API.
    лицензия Объект лицензии Информация о лицензии для открытого API.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример информационного объекта:
     {
      "title": "Образец приложения Swagger",
      "description": "Это пример сервера Petstore server.",
      "termsOfService": "http://swagger.io/terms/",
      "контакт": {
        "name": "Поддержка API",
        "url": "http: // www.swagger.io/support ",
        "электронная почта": "[email protected]"
      },
      "лицензия": {
        "name": "Apache 2.0",
        "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
      },
      "версия": "1.0.1"
    } 
     title: Образец приложения Swagger
    описание: Это пример сервера Petstore server.
    termsOfService: http://swagger.io/terms/
    контакт:
      имя: Поддержка API
      URL: http://www.swagger.io/support
      электронная почта: [email protected]
    лицензия:
      имя: Apache 2.0
      URL: http://www.apache.org/licenses/LICENSE-2.0.html
    версия: 1.0,1 
    Контактный объект

    Контактная информация для открытого API.

    Фиксированные поля
    Имя поля Тип Описание
    название строка Идентификационное имя контактного лица / организации.
    URL строка URL-адрес, указывающий на контактную информацию. ДОЛЖЕН быть в формате URL.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Контактный объект Пример:
     {
      "name": "Поддержка API",
      "url": "http://www.swagger.io/support",
      "электронная почта": "[email protected]"
    } 
     имя: Поддержка API
    URL: http: // www.swagger.io/support
    электронная почта: [email protected] 
    Объект лицензии

    Информация о лицензии для открытого API.

    Фиксированные поля
    Имя поля Тип Описание
    название строка Обязательно. Имя лицензии, используемой для API.
    URL строка URL-адрес лицензии, используемой для API.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта лицензии:
     {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    } 
     имя: Apache 2.0
    URL: http://www.apache.org/licenses/LICENSE-2.0.html 
    Путь, объект

    Содержит относительные пути к отдельным конечным точкам. Путь добавляется к basePath для создания полного URL-адреса. Пути могут быть пустыми из-за ограничений ACL.

    Узорчатые поля
    Схема поля Тип Описание
    / {path} Объект Path Item Относительный путь к отдельной конечной точке. Имя поля ДОЛЖНО начинаться с косой черты.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта Paths
     {
      "/домашние питомцы": {
        "получать": {
          "description": "Возвращает всех животных из системы, к которой у пользователя есть доступ",
          "производит": [
            "приложение / json"
          ],
          "ответы": {
            "200": {
              "description": "Список домашних животных.",
              "schema": {
                "тип": "массив",
                "Предметы": {
                  "$ ref": "# / definitions / pet"
                }
              }
            }
          }
        }
      }
    } 
     / домашние животные:
      получать:
        описание: возвращает всех домашних животных из системы, к которой у пользователя есть доступ
        производит:
        - приложение / json
        ответы:
          '200':
            описание: Список домашних животных.
            схема:
              тип: массив
              Предметы:
                $ ref: '# / definitions / pet' 
    Объект Path Item

    Описывает операции, доступные на одном пути.Элемент пути может быть пустым из-за ограничений ACL. Сам путь по-прежнему доступен для просмотра документации, но они не будут знать, какие операции и параметры доступны.

    Фиксированные поля
    Имя поля Тип Описание
    $ исх. строка Позволяет внешнее определение этого элемента пути. Указанная структура ДОЛЖНА быть в формате объекта Path Item.Если есть конфликты между указанным определением и определением этого элемента пути, поведение будет undefined .
    получить Операция Объект Определение операции GET на этом пути.
    положить Операция Объект Определение операции PUT на этом пути.
    пост Операция Объект Определение операции POST на этом пути.
    удалить Операция Объект Определение операции DELETE на этом пути.
    варианты Операция Объект Определение операции OPTIONS на этом пути.
    головка Операция Объект Определение операции HEAD на этом пути.
    патч Операция Объект Определение операции PATCH на этом пути.
    параметры [Объект параметра | Справочный объект] Список параметров, применимых для всех операций, описанных в этом пути. Эти параметры можно переопределить на уровне операции, но нельзя там удалить. Список НЕ ДОЛЖЕН включать повторяющиеся параметры. Уникальный параметр определяется комбинацией имени и местоположения. Список может использовать ссылочный объект для связи с параметрами, которые определены в параметрах объекта Swagger.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта "Путь"
     {
      "получать": {
        "description": "Возвращает домашних животных по ID",
        "summary": "Найти питомца по идентификатору",
        "operationId": "getPetsById",
        "производит": [
          "приложение / json",
          "текст / HTML"
        ],
        "ответы": {
          "200": {
            "описание": "ответ питомца",
            "schema": {
              "тип": "массив",
              "Предметы": {
                "$ ref": "# / definitions / Pet"
              }
            }
          },
          "По умолчанию": {
            "описание": "полезная нагрузка ошибки",
            "schema": {
              "$ ref": "# / definitions / ErrorModel"
            }
          }
        }
      },
      "параметры": [
        {
          "имя": "идентификатор",
          "in": "путь",
          "description": "ID животного для использования",
          "требуется": правда,
          "тип": "массив",
          "Предметы": {
            "тип": "строка"
          },
          "collectionFormat": "csv"
        }
      ]
    } 
     получить:
      описание: Возвращает домашних животных на основании ID
      резюме: поиск домашних животных по идентификатору
      operationId: getPetsById
      производит:
      - приложение / json
      - текст / HTML
      ответы:
        '200':
          описание: ответ питомца
          схема:
            тип: массив
            Предметы:
              $ ref: '# / definitions / Pet'
        По умолчанию:
          описание: полезная нагрузка ошибки
          схема:
            $ ref: '# / определений / ErrorModel'
    параметры:
    - имя: id
      в: путь
      описание: ID питомца для использования
      требуется: правда
      тип: массив
      Предметы:
        тип: строка
      Формат коллекции: csv 
    Операционный объект

    Описывает одну операцию API на пути.

    Фиксированные поля
    Имя поля Тип Описание
    теги [ строка ] Список тегов для управления документацией API. Теги могут использоваться для логической группировки операций по ресурсам или любому другому квалификатору.
    сводка строка Краткое описание того, что делает операция. Для максимальной читабельности swagger-ui это поле ДОЛЖНО быть меньше 120 символов.
    описание строка Подробное объяснение поведения операции. Синтаксис GFM можно использовать для форматированного текстового представления.
    внешние документы Объект внешней документации Дополнительная внешняя документация для этой операции.
    operationId строка Уникальная строка, используемая для идентификации операции. Идентификатор ДОЛЖЕН быть уникальным среди всех операций, описанных в API.Инструменты и библиотеки МОГУТ использовать OperationId для однозначной идентификации операции, поэтому рекомендуется следовать общепринятым соглашениям об именах программирования.
    потребляет [ строка ] Список типов MIME, которые может использовать операция. Это отменяет определение потребляет в объекте Swagger. Пустое значение МОЖЕТ использоваться для очистки глобального определения. Значение ДОЛЖНО быть таким, как описано в разделе Типы Mime.
    производит [ строка ] Список типов MIME, которые может создать операция.Это отменяет и создает определение в объекте Swagger. Пустое значение МОЖЕТ использоваться для очистки глобального определения. Значение ДОЛЖНО быть таким, как описано в разделе Типы Mime.
    параметры [Объект параметра | Справочный объект] Список параметров, применимых к этой операции. Если параметр уже определен в элементе пути, новое определение переопределит его, но никогда не сможет удалить. Список НЕ ДОЛЖЕН включать повторяющиеся параметры.Уникальный параметр определяется комбинацией имени и местоположения. Список может использовать ссылочный объект для связи с параметрами, которые определены в параметрах объекта Swagger. Параметр "body" может быть максимум один.
    ответов Ответы Объект Обязательно. Список возможных ответов, возвращаемых при выполнении этой операции.
    схемы [ строка ] Протокол передачи для операции.Значения ДОЛЖНЫ быть из списка: «http» , «https» , «ws» , «wss» . Значение переопределяет определение схемы Swagger Object .
    устарело логическое Объявляет эту операцию устаревшей. Следует воздержаться от использования заявленной операции. Значение по умолчанию: , ложь .
    безопасность [Объект требований безопасности] Объявление того, какие схемы безопасности применяются для данной операции.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта операции
     {
      "теги": [
        "домашний питомец"
      ],
      "summary": "Обновляет питомца в магазине данными формы",
      "описание": "",
      "operationId": "updatePetWithForm",
      "потребляет": [
        "application / x-www-form-urlencoded"
      ],
      "производит": [
        "приложение / json",
        "приложение / xml"
      ],
      "параметры": [
        {
          "name": "petId",
          "in": "путь",
          "description": "ID питомца, которого необходимо обновить",
          "требуется": правда,
          "тип": "строка"
        },
        {
          "name": "name",
          "в": "formData",
          "description": "Обновлено имя питомца",
          "требуется": ложь,
          "тип": "строка"
        },
        {
          "имя": "статус",
          "в": "formData",
          "description": "Обновленный статус питомца",
          "требуется": ложь,
          "тип": "строка"
        }
      ],
      "ответы": {
        "200": {
          "description": "Питомец обновлен."
        },
        "405": {
          "description": "Неверный ввод"
        }
      },
      "безопасность": [
        {
          "petstore_auth": [
            "написать: домашние животные",
            "читать: домашние животные"
          ]
        }
      ]
    } 
     тегов:
    - домашний питомец
    сводка: обновляет питомца в магазине данными формы
    описание: ""
    operationId: updatePetWithForm
    потребляет:
    - приложение / x-www-form-urlencoded
    производит:
    - приложение / json
    - приложение / xml
    параметры:
    - имя: petId
      в: путь
      описание: ID питомца, которого нужно обновить
      требуется: правда
      тип: строка
    - имя: имя
      in: formData
      описание: Обновлено имя питомца
      требуется: ложь
      тип: строка
    - имя: статус
      in: formData
      описание: Обновлен статус питомца
      требуется: ложь
      тип: строка
    ответы:
      '200':
        описание: Питомец обновлен.'405':
        описание: неверный ввод
    безопасность:
    - petstore_auth:
      - напишите: домашние животные
      - читать: домашние животные 
    Объект внешней документации

    Позволяет ссылаться на внешний ресурс для получения расширенной документации.

    Фиксированные поля
    Имя поля Тип Описание
    описание строка Краткое описание целевой документации. Синтаксис GFM можно использовать для форматированного текстового представления.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта внешней документации
     {
      "description": "Подробнее здесь",
      "url": "https://swagger.io"
    } 
     описание: Дополнительная информация здесь
    url: https: // чванство.io 
    Объект параметров

    Описывает один параметр операции.

    Уникальный параметр определяется комбинацией имени и местоположения.

    Существует пять возможных типов параметров.

    • Путь - используется вместе с шаблоном пути, где значение параметра фактически является частью URL-адреса операции. Это не включает хост или базовый путь API. Например, в / items / {itemId} параметр пути - itemId .
    • Запрос - параметры, добавляемые к URL-адресу. Например, в / items? Id = ### параметр запроса - id .
    • Заголовок - настраиваемые заголовки, ожидаемые как часть запроса.
    • Body - полезная нагрузка, добавляемая к HTTP-запросу. Поскольку может быть только одна полезная нагрузка, может быть только один параметр тела . Имя параметра тела не влияет на сам параметр и используется только для целей документации.Поскольку параметры формы также находятся в полезной нагрузке, параметры тела и формы не могут существовать вместе для одной и той же операции.
    • Форма
    • - используется для описания полезной нагрузки HTTP-запроса, когда application / x-www-form-urlencoded , multipart / form-data или оба используются в качестве типа содержимого запроса (в определении Swagger потребляет свойство операции). Это единственный тип параметра, который можно использовать для отправки файлов, таким образом поддерживая тип файл .Поскольку параметры формы отправляются в полезной нагрузке, они не могут быть объявлены вместе с параметром тела для одной и той же операции. Параметры формы имеют другой формат в зависимости от используемого типа содержимого (для получения дополнительной информации см. Http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
      • application / x-www-form-urlencoded - Аналогично формату параметров запроса, но в качестве полезной нагрузки. Например, foo = 1 & bar = swagger - и foo , и bar являются параметрами формы.Обычно это используется для простых передаваемых параметров.
      • multipart / form-data - каждый параметр занимает часть полезной нагрузки с внутренним заголовком. Например, для заголовка Content-Disposition: form-data; name = "submit-name" имя параметра - имя-отправки . Этот тип параметров формы чаще используется для передачи файлов.
    Фиксированные поля
    Имя поля Тип Описание
    название строка Обязательно. Имя параметра. Имена параметров чувствительны к регистру .
    • Если в - это "путь" , поле имени ДОЛЖНО соответствовать связанному сегменту пути из поля пути в объекте путей. См. Шаблон пути для получения дополнительной информации.
    • Во всех остальных случаях имя соответствует имени параметра, используемому на основе в свойстве .
    дюйм строка Обязательно. Расположение параметра. Возможные значения: query, header, path, formData или body.
    описание строка Краткое описание параметра. Это может содержать примеры использования. Синтаксис GFM можно использовать для форматированного текстового представления.
    требуется логическое Определяет, является ли этот параметр обязательным. Если параметр в «пути», это свойство требуется и его значение ДОЛЖНО быть истинно .В противном случае свойство МОЖЕТ быть включено, и его значение по умолчанию - false .

    Если в - это "тело" :

    Имя поля Тип Описание
    схема Объект схемы Обязательно. Схема, определяющая тип, используемый для параметра тела.

    Если в - любое значение, кроме "body" :

    Коллекция
    Имя поля Тип Описание
    тип строка Обязательно. Тип параметра. Поскольку параметр не находится в теле запроса, он ограничен простыми типами (то есть не объектом). Значение ДОЛЖНО быть одним из "строка" , "число" , "целое число" , "логическое" , "массив" или "файл" . Если тип - это «файл» , потребляет ДОЛЖЕН быть либо «multipart / form-data», , «application / x-www-form-urlencoded», или оба, и параметр ДОЛЖЕН быть в "formData" .
    формат строка Расширяемый формат для ранее упомянутого типа . Дополнительные сведения см. В разделе «Форматы типов данных».
    allowEmptyValue логическое Устанавливает возможность передачи параметров с пустыми значениями. Это действительно только для параметров запроса или formData и позволяет отправлять параметр только с именем или с пустым значением. Значение по умолчанию: , ложь .
    шт. Предметы Объект Требуется, если тип - «массив». Описывает тип элементов в массиве.
    Формат строка Определяет формат массива, если используется тип array. Возможные значения:
    • csv - значения, разделенные запятыми foo, bar .
    • ssv - значения, разделенные пробелом foo bar .
    • tsv - значения, разделенные табуляцией foo \ tbar .
    • трубы - значения, разделенные трубками foo | bar .
    • multi - соответствует нескольким экземплярам параметров вместо нескольких значений для одного экземпляра foo = bar & foo = baz . Это действительно только для параметров в «query» или «formData».
    Значение по умолчанию - csv .
    по умолчанию * Объявляет значение параметра, которое сервер будет использовать, если он не указан, например «счетчик» для управления количеством результатов на странице может по умолчанию равняться 100, если он не указан клиентом в запросе.(Примечание: "default" не имеет значения для обязательных параметров.) См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. В отличие от схемы JSON это значение ДОЛЖНО соответствовать определенному типу для этого параметра.
    максимум номер См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
    эксклюзивно Максимум логическое См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2.
    минимум номер См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
    эксклюзивный минимум логическое См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3.
    макс. Длина целое См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1.
    мин Длина целое См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2.
    узор строка См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3.
    макс. целое См. Https: // tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2.
    минЭлементы целое См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3.
    уникальные позиции логическое См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4.
    перечисление [*] См. Https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Примеры объектов параметров
    Параметры кузова

    Параметр тела с определением схемы, на которую имеется ссылка (обычно для определения модели):

     {
      "имя": "пользователь",
      "в": "тело",
      "описание": "пользователь, которого нужно добавить в систему",
      "требуется": правда,
      "schema": {
        "$ ref": "# / определений / Пользователь"
      }
    } 
     имя: пользователь
    в: тело
    описание: пользователь, которого нужно добавить в систему
    требуется: правда
    схема:
      $ ref: '# / definitions / User' 

    Параметр тела, представляющий собой массив строковых значений:

     {
      "имя": "пользователь",
      "в": "тело",
      "описание": "пользователь, которого нужно добавить в систему",
      "требуется": правда,
      "schema": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка"
        }
      }
    } 
     имя: пользователь
    в: тело
    описание: пользователь, которого нужно добавить в систему
    требуется: правда
    схема:
      тип: массив
      Предметы:
        тип: строка 
    Другие параметры

    Параметр заголовка с массивом 64-битных целых чисел:

     {
      "имя": "токен",
      "в": "заголовок",
      "description": "токен для передачи в качестве заголовка",
      "требуется": правда,
      "тип": "массив",
      "Предметы": {
        "тип": "целое число",
        "формат": "int64"
      },
      "collectionFormat": "csv"
    } 
     имя: токен
    в: заголовок
    описание: токен для передачи в качестве заголовка
    требуется: правда
    тип: массив
    Предметы:
      тип: целое число
      формат: int64
    Формат коллекции: csv 

    Параметр пути строкового значения:

     {
      "name": "имя пользователя",
      "in": "путь",
      "описание": "имя пользователя для получения",
      "требуется": правда,
      "тип": "строка"
    } 
     имя: имя пользователя
    в: путь
    описание: имя пользователя для получения
    требуется: правда
    тип: строка 

    Необязательный параметр запроса строкового значения, допускающий несколько значений путем повторения параметра запроса:

     {
      "имя": "идентификатор",
      "в": "запрос",
      "description": "ID извлекаемого объекта",
      "требуется": ложь,
      "тип": "массив",
      "Предметы": {
        "тип": "строка"
      },
      "collectionFormat": "multi"
    } 
     имя: id
    в: запрос
    описание: ID объекта для выборки
    требуется: ложь
    тип: массив
    Предметы:
      тип: строка
    collectionFormat: multi 

    Данные формы с типом файла для загрузки файла:

     {
      "имя": "аватар",
      "в": "formData",
      "description": "Аватар пользователя",
      "требуется": правда,
      "тип": "файл"
    } 
     имя: аватар
    in: formData
    описание: аватар пользователя
    требуется: правда
    тип: файл 
    Предметы Объект

    Ограниченное подмножество объекта items JSON-Schema.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».

    Предметы Примеры объектов

    Элементы должны быть строкового типа и иметь минимальную длину 2 символа:

     {
        "тип": "строка",
        «minLength»: 2
    } 
     тип: строка
    minДлина: 2 

    Массив массивов, внутренний массив имеет целочисленный тип, числа должны быть от 0 до 63 (включительно):

     {
        "тип": "массив",
        "Предметы": {
            "тип": "целое число",
            «минимум»: 0,
            «максимум»: 63
        }
    } 
     тип: массив
    Предметы:
      тип: целое число
      минимум: 0
      максимум: 63 
    Ответы Объект

    Контейнер для ожидаемых ответов операции.Контейнер сопоставляет код ответа HTTP с ожидаемым ответом. От документации не ожидается, что она обязательно будет охватывать все возможные коды ответов HTTP, поскольку они могут быть неизвестны заранее. Однако ожидается, что в документации будут указаны успешный ответ операции и любые известные ошибки.

    Значение по умолчанию можно использовать в качестве объекта ответа по умолчанию для всех кодов HTTP, которые отдельно не рассматриваются в спецификации.

    Объект ответов ДОЛЖЕН содержать по крайней мере один код ответа, и он ДОЛЖЕН быть ответом на успешный вызов операции.

    Фиксированные поля
    Узорчатые поля
    Ответы Пример объекта

    Ответ 200 для успешной операции и ответ по умолчанию для других (подразумевающий ошибку):

     {
      "200": {
        "description": "домашнее животное будет возвращено",
        "schema": {
          "$ ref": "# / definitions / Pet"
        }
      },
      "По умолчанию": {
        "description": "Неожиданная ошибка",
        "schema": {
          "$ ref": "# / definitions / ErrorModel"
        }
      }
    } 
     '200':
      описание: домашнее животное будет возвращено
      схема:
        $ ref: '# / definitions / Pet'
    По умолчанию:
      описание: Неожиданная ошибка
      схема:
        $ ref: '# / definitions / ErrorModel' 
    Объект ответа

    Описывает отдельный ответ от операции API. x- Любые Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».

    Примеры объектов ответа

    Ответ массива сложного типа:

     {
      "description": "Ответ на сложный массив объектов",
      "schema": {
        "тип": "массив",
        "Предметы": {
          "$ ref": "# / definitions / VeryComplexType"
        }
      }
    } 
    Описание
    : ответ на сложный объектный массив
    схема:
      тип: массив
      Предметы:
        $ ref: '# / definitions / VeryComplexType' 

    Ответ со строковым типом:

     {
      "description": "Простой строковый ответ",
      "schema": {
        "тип": "строка"
      }
    } 
    Описание
    : простой строковый ответ
    схема:
      тип: строка 

    Ответ с заголовками:

     {
      "description": "Простой строковый ответ",
      "schema": {
        "тип": "строка"
      },
      "заголовки": {
        "X-Rate-Limit-Limit": {
          "description": "Количество разрешенных запросов в текущем периоде",
          "тип": "целое число"
        },
        "X-Rate-Limit-Remaining": {
          "description": "Количество оставшихся запросов в текущем периоде",
          "тип": "целое число"
        },
        "X-Rate-Limit-Reset": {
          "description": "Количество секунд до конца текущего периода",
          "тип": "целое число"
        }
      }
    } 
    Описание
    : простой строковый ответ
    схема:
      тип: строка
    заголовки:
      X-Rate-Limit-Limit:
        описание: количество разрешенных запросов за текущий период
        тип: целое число
      Остающийся предел X-скорости:
        описание: количество оставшихся запросов в текущем периоде
        тип: целое число
      X-Скорость-Предел-Сброс:
        описание: количество секунд до конца текущего периода
        тип: целое число 

    Ответ без возвращаемого значения:

     {
      "описание": "объект создан"
    } 
     описание: объект создан 
    Заголовки Объект

    Перечисляет заголовки, которые могут быть отправлены как часть ответа.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} Заголовок, объект Имя свойства соответствует имени заголовка. Значение описывает тип заголовка.
    Пример объекта заголовков

    Заголовки ограничения скорости:

     {
        "X-Rate-Limit-Limit": {
            "description": "Количество разрешенных запросов в текущем периоде",
            "тип": "целое число"
        },
        "X-Rate-Limit-Remaining": {
            "description": "Количество оставшихся запросов в текущем периоде",
            "тип": "целое число"
        },
        "X-Rate-Limit-Reset": {
            "description": "Количество секунд до конца текущего периода",
            "тип": "целое число"
        }
    } 
     X-Rate-Limit-Limit:
      описание: количество разрешенных запросов за текущий период
      тип: целое число
    Остающийся предел X-скорости:
      описание: количество оставшихся запросов в текущем периоде
      тип: целое число
    X-Скорость-Предел-Сброс:
      описание: количество секунд до конца текущего периода
      тип: целое число 
    Пример объекта

    Позволяет обмениваться примерами рабочих ответов.

    Узорчатые поля
    Схема поля Тип Описание
    {тип пантомимы} Любые Имя свойства ДОЛЖНО быть одним из следующих: Операция производит значений (неявных или унаследованных). Значение ДОЛЖНО быть примером того, как будет выглядеть такой ответ.
    Пример объекта Пример

    Пример ответа для mimetype application / json типа данных Pet:

     {
      "application / json": {
        "name": "Пума",
        "type": "Собака",
        "черный цвет",
        "женский пол",
        «порода»: «Смешанный»
      }
    } 
     приложение / json:
      имя: Пума
      тип: Собака
      черный цвет
      женский пол
      порода: смешанная 
    Объект заголовка
    Узорчатые предметы
    Схема поля Тип Описание
    ^ x- Любые Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта заголовка

    Простой заголовок целочисленного типа:

     {
      "description": "Количество разрешенных запросов в текущем периоде",
      "тип": "целое число"
    } 
     описание: количество разрешенных запросов в текущем периоде
    тип: целое число 
    Тег объекта

    Позволяет добавлять метаданные к одному тегу, который используется объектом операции.Наличие объекта тега для каждого тега не является обязательным.

    Фиксированные поля
    Имя поля Тип Описание
    название строка Обязательно. Имя тега.
    описание строка Краткое описание тега. Синтаксис GFM можно использовать для форматированного текстового представления.
    внешние документы Объект внешней документации Дополнительная внешняя документация для этого тега.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта тега
     {
    "имя": "домашнее животное",
    "description": "Домашние животные"
    } 
     имя: домашнее животное
    описание: Домашние животные 
    Ссылочный объект

    Простой объект, позволяющий ссылаться на другие определения в спецификации.Его можно использовать для ссылки на параметры и ответы, которые определены на верхнем уровне для повторного использования.

    Ссылочный объект - это ссылка JSON, в которой в качестве значения используется указатель JSON. Для этой спецификации поддерживается только каноническое разыменование.

    Фиксированные поля
    Имя поля Тип Описание
    $ исх. строка Обязательно. Ссылочная строка.
    Пример ссылочного объекта
     {
    "$ ref": "# / definitions / Pet"
    } 
     $ ref: '# / definitions / Pet' 
    Пример файла относительной схемы
    Пример относительных файлов со встроенной схемой
     {
      "$ ref": "definitions.json # / Pet"
    } 
     $ ref: 'definitions.yaml # / Pet' 
    Объект схемы

    Объект схемы позволяет определять типы входных и выходных данных. Эти типы могут быть объектами, а также примитивами и массивами.Этот объект основан на проекте 4 спецификации схемы JSON и использует его предопределенное подмножество. Помимо этого подмножества, в данной спецификации предусмотрены расширения, позволяющие получить более полную документацию.

    Дополнительную информацию о свойствах можно найти в JSON Schema Core и JSON Schema Validation. Если не указано иное, определения свойств соответствуют спецификации схемы JSON, указанной здесь.

    Следующие свойства взяты непосредственно из определения схемы JSON и соответствуют тем же спецификациям:

    • $ ref - Ссылка в формате JSON
    • Формат
    • (дополнительные сведения см. В разделе «Форматы типов данных»)
    • титул
    • описание (синтаксис GFM может использоваться для форматированного текстового представления)
    • по умолчанию (в отличие от схемы JSON, значение ДОЛЖНО соответствовать определенному типу для объекта схемы)
    • кратное из
    • максимум
    • эксклюзивный Максимум
    • минимум
    • эксклюзивный минимум
    • макс. Длина
    • мин Длина
    • узор
    • макс.
    • минЭлементы
    • уникальных предметов
    • maxProperties
    • минОбъекты собственности
    • требуется
    • перечисление
    • тип

    Следующие свойства взяты из определения схемы JSON, но их определения были скорректированы в соответствии со спецификацией Swagger.Их определение такое же, как и в схеме JSON, только там, где исходное определение ссылается на определение схемы JSON, вместо этого используется определение объекта схемы.

    • позиции
    • все из
    • объектов
    • дополнительная недвижимость

    Кроме полей подмножества схемы JSON, следующие поля могут использоваться для дальнейшей документации схемы.

    Фиксированные поля
    Имя поля Тип Описание
    дискриминатор строка Добавляет поддержку полиморфизма.Дискриминатор - это имя свойства схемы, которое используется для различения других схем, наследующих эту схему. Используемое имя свойства ДОЛЖНО быть определено в этой схеме и ДОЛЖНО быть в списке требуемых свойств . При использовании значение ДОЛЖНО быть именем этой схемы или любой схемы, которая ее наследует.
    Только чтение логическое Актуально только для определений "свойств" схемы . Объявляет свойство как «только для чтения».Это означает, что он МОЖЕТ быть отправлен как часть ответа, но НЕ ДОЛЖЕН быть отправлен как часть запроса. Свойства, помеченные как readOnly is true НЕ ДОЛЖНЫ быть в списке required определенной схемы. Значение по умолчанию: , ложь .
    xml Объект XML МОЖЕТ использоваться только в схемах свойств. Это не влияет на корневые схемы. Добавляет дополнительные метаданные для описания формата XML-представления этого свойства.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Состав и наследование (полиморфизм)

    Swagger позволяет комбинировать и расширять определения модели с помощью свойства allOf схемы JSON, фактически предлагая композицию модели. allOf принимает массив определений объектов, которые проверяются независимо , но вместе составляют единый объект.

    Хотя композиция предлагает расширяемость модели, она не подразумевает иерархию между моделями. Для поддержки полиморфизма Swagger добавляет поддержку поля дискриминатора . При использовании дискриминатор будет именем свойства, используемого для принятия решения о том, какое определение схемы используется для проверки структуры модели.Таким образом, поле дискриминатора ДОЛЖНО быть обязательным полем. Значение выбранного свойства должно быть понятным именем, присвоенным модели в соответствии с определением свойством . Таким образом, определения встроенных схем, которые не имеют заданного идентификатора , не могут использоваться в полиморфизме .

    Моделирование XML

    Свойство xml допускает дополнительные определения при переводе определения JSON в XML. XML-объект содержит дополнительную информацию о доступных параметрах.

    Примеры объектов схемы
    Примитивный образец

    В отличие от предыдущих версий Swagger, определения схемы также могут использоваться для описания примитивов и массивов.

     {
        "тип": "строка",
        "формат": "электронная почта"
    } 
     тип: строка
    формат: электронная почта 
    Простая модель
     {
      "тип": "объект",
      "обязательный": [
        "название"
      ],
      "характеристики": {
        "название": {
          "тип": "строка"
        },
        "адрес": {
          "$ ref": "# / определений / Адрес"
        },
        "возраст": {
          "тип": "целое число",
          "формат": "int32",
          «минимум»: 0
        }
      }
    } 
     тип: объект
    обязательный:
    - название
    характеристики:
      название:
        тип: строка
      адрес:
        $ ref: '# / определений / Адрес'
      возраст:
        тип: целое число
        формат: int32
        минимум: 0 
    Модель
    со свойствами карты / словаря

    Для отображения простой строки в строку:

     {
      "тип": "объект",
      "additionalProperties": {
        "тип": "строка"
      }
    } 
     тип: объект
    AdditionalProperties:
      тип: строка 

    Для сопоставления строки с моделью:

     {
      "тип": "объект",
      "additionalProperties": {
        "$ ref": "# / definitions / ComplexModel"
      }
    } 
     тип: объект
    AdditionalProperties:
      $ ref: '# / definitions / ComplexModel' 
    Модель
    с примером
     {
      "тип": "объект",
      "характеристики": {
        "я бы": {
          "тип": "целое число",
          "формат": "int64"
        },
        "название": {
          "тип": "строка"
        }
      },
      "обязательный": [
        "название"
      ],
      "пример": {
        "name": "Пума",
        "id": 1
      }
    } 
     тип: объект
    характеристики:
      я бы:
        тип: целое число
        формат: int64
      название:
        тип: строка
    обязательный:
    - название
    пример:
      имя: Пума
      id: 1 
    Модели с составом
     {
      "definitions": {
        "ErrorModel": {
          "тип": "объект",
          "обязательный": [
            "сообщение",
            "код"
          ],
          "характеристики": {
            "сообщение": {
              "тип": "строка"
            },
            "code": {
              "тип": "целое число",
              «минимум»: 100,
              «максимум»: 600
            }
          }
        },
        "ExtendedErrorModel": {
          "все": [
            {
              "$ ref": "# / definitions / ErrorModel"
            },
            {
              "тип": "объект",
              "обязательный": [
                "первопричина"
              ],
              "характеристики": {
                "первопричина": {
                  "тип": "строка"
                }
              }
            }
          ]
        }
      }
    } 
     определений:
      ErrorModel:
        тип: объект
        обязательный:
        - сообщение
        - код
        характеристики:
          сообщение:
            тип: строка
          код:
            тип: целое число
            минимум: 100
            максимум: 600
      ExtendedErrorModel:
        все:
        - $ ref: '# / definitions / ErrorModel'
        - тип: объект
          обязательный:
          - первопричина
          характеристики:
            первопричина:
              тип: строка 
    Модели с поддержкой полиморфизма
     {
      "definitions": {
        "Домашний питомец": {
          "тип": "объект",
          "дискриминатор": "petType",
          "характеристики": {
            "название": {
              "тип": "строка"
            },
            "petType": {
              "тип": "строка"
            }
          },
          "обязательный": [
            "название",
            "petType"
          ]
        },
        "Кот": {
          "description": "Изображение кота",
          "все": [
            {
              "$ ref": "# / definitions / Pet"
            },
            {
              "тип": "объект",
              "характеристики": {
                "untingSkill ": {
                  "тип": "строка",
                  "description": "Измеряемый навык для охоты",
                  "по умолчанию": "ленивый",
                  "перечисление": [
                    "невежественный",
                    "ленивый",
                    "авантюрный",
                    "агрессивный"
                  ]
                }
              },
              "обязательный": [
                "охотничье мастерство"
              ]
            }
          ]
        },
        "Собака": {
          "description": "Изображение собаки",
          "все": [
            {
              "$ ref": "# / definitions / Pet"
            },
            {
              "тип": "объект",
              "характеристики": {
                "packSize": {
                  "тип": "целое число",
                  "формат": "int32",
                  "description": "размер стаи собаки",
                  "по умолчанию": 0,
                  «минимум»: 0
                }
              },
              "обязательный": [
                "packSize"
              ]
            }
          ]
        }
      }
    } 
     определений:
      Домашний питомец:
        тип: объект
        дискриминатор: petType
        характеристики:
          название:
            тип: строка
          petType:
            тип: строка
        обязательный:
        - название
        - petType
      Кот:
        описание: Изображение кошки
        все:
        - $ ref: '# / definitions / Pet'
        - тип: объект
          характеристики:
            охотничий навык:
              тип: строка
              описание: Измеряемый навык для охоты.
              по умолчанию: ленивый
              перечисление:
              - невежественный
              - ленивый
              - авантюрный
              - агрессивный
          обязательный:
          - охотничье мастерство
      Собака:
        описание: Изображение собаки
        все:
        - $ ref: '# / definitions / Pet'
        - тип: объект
          характеристики:
            packSize:
              тип: целое число
              формат: int32
              описание: размер стаи собаки
              по умолчанию: 0
              минимум: 0
          обязательный:
          - размер упаковки 
    Объект XML

    Объект метаданных, позволяющий более точно настраивать определения модели XML.

    При использовании массивов имена элементов XML являются , а не (для форм единственного / множественного числа), и для добавления этой информации следует использовать свойство name . См. Примеры ожидаемого поведения.

    Фиксированные поля
    Имя поля Тип Описание
    название строка Заменяет имя элемента / атрибута, используемого для описанного свойства схемы.Когда он определен в объекте Items ( items ), он повлияет на имя отдельных XML-элементов в списке. Когда он определен рядом с типом , является массивом (за пределами элементов ), он будет влиять на элемент упаковки, и только если обернутый будет истинным . Если обернутый - это false , он будет проигнорирован.
    пространство имен строка URL-адрес определения пространства имен.Значение ДОЛЖНО быть в форме URL.
    префикс строка Префикс, который будет использоваться для имени.
    атрибут логическое Объявляет, преобразуется ли определение свойства в атрибут, а не в элемент. x- Любые Разрешает расширения схемы Swagger.Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Примеры объектов XML

    Примеры определений объекта XML включены в определение свойства объекта схемы с образцом его представления XML.

    Нет элемента XML

    Базовое свойство строки:

     {
        "animals": {
            "тип": "строка"
        }
    } 

    Свойство базового строкового массива ( завернутый - false по умолчанию):

     {
        "animals": {
            "тип": "массив",
            "Предметы": {
                "тип": "строка"
            }
        }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка 
     <животные>... 
    <животные> ... 
    <животные> ...  
    Замена имени XML
     {
      "animals": {
        "тип": "строка",
        "xml": {
          "имя": "животное"
        }
      }
    } 
     животных:
      тип: строка
      xml:
        название: животное 
    Атрибут, префикс и пространство имен XML

    В этом примере показано полное определение модели.

     {
      "Человек": {
        "тип": "объект",
        "характеристики": {
          "я бы": {
            "тип": "целое число",
            "формат": "int32",
            "xml": {
              "атрибут": истина
            }
          },
          "название": {
            "тип": "строка",
            "xml": {
              "пространство имен": "http: // чванство.io / schema / sample ",
              "префикс": "образец"
            }
          }
        }
      }
    } 
     Человек:
      тип: объект
      характеристики:
        я бы:
          тип: целое число
          формат: int32
          xml:
            атрибут: истина
        название:
          тип: строка
          xml:
            пространство имен: http://swagger.io/schema/sample
            префикс: образец 
     <Лицо>
         пример 
     
    Массивы XML

    Изменение названий элементов:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка",
          "xml": {
            "имя": "животное"
          }
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
        xml:
          название: животное 
      значение 
     значение  

    Внешнее имя , свойство не влияет на XML:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка",
          "xml": {
            "имя": "животное"
          }
        },
        "xml": {
          "имя": "пришельцы"
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
        xml:
          имя: животное
      xml:
        имя: пришельцы 
      значение 
     значение  

    Даже если массив обернут, если имя не определено явно, одно и то же имя будет использоваться как для внутреннего, так и для внешнего использования:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка"
        },
        "xml": {
          "завернутый": правда
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
      xml:
        завернутый: правда 
     <животные>
       значение 
       значение 
     

    Чтобы преодолеть приведенный выше пример, можно использовать следующее определение:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка",
          "xml": {
            "имя": "животное"
          }
        },
        "xml": {
          "завернутый": правда
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
        xml:
          имя: животное
      xml:
        завернутый: правда 
     <животные>
       значение 
       значение 
     

    Затрагивает как внутренние, так и внешние имена:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка",
          "xml": {
            "имя": "животное"
          }
        },
        "xml": {
          "name": "пришельцы",
          "завернутый": правда
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
        xml:
          имя: животное
      xml:
        имя: пришельцы
        завернутый: правда 
     <пришельцы>
       значение 
       значение 
     

    Если поменять внешний элемент, а не внутренний:

     {
      "animals": {
        "тип": "массив",
        "Предметы": {
          "тип": "строка"
        },
        "xml": {
          "name": "пришельцы",
          "завернутый": правда
        }
      }
    } 
     животных:
      тип: массив
      Предметы:
        тип: строка
      xml:
        имя: пришельцы
        завернутый: правда 
     <пришельцы>
       ценность 
       ценность 
     
    Объект определений

    Объект для хранения типов данных, которые могут использоваться и создаваться операциями.Эти типы данных могут быть примитивами, массивами или моделями.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} Объект схемы Одиночное определение, сопоставляющее «имя» с определяемой им схемой.
    Определения Пример объекта
     {
      "Категория": {
        "тип": "объект",
        "характеристики": {
          "я бы": {
            "тип": "целое число",
            "формат": "int64"
          },
          "название": {
            "тип": "строка"
          }
        }
      },
      "Тег": {
        "тип": "объект",
        "характеристики": {
          "я бы": {
            "тип": "целое число",
            "формат": "int64"
          },
          "название": {
            "тип": "строка"
          }
        }
      }
    } 
     Категория:
      тип: объект
      характеристики:
        я бы:
          тип: целое число
          формат: int64
        название:
          тип: строка
    Тег:
      тип: объект
      характеристики:
        я бы:
          тип: целое число
          формат: int64
        название:
          тип: строка 
    Объект определения параметров

    Объект для хранения параметров, которые будут повторно использоваться во всех операциях.Определения параметров можно ссылаться на те, которые определены здесь.

    Это не , а не определяет глобальные параметры операции.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} Параметр Объект Определение отдельного параметра, сопоставляющее "имя" определяемому параметру.
    Пример объекта определения параметров
     {
      "skipParam": {
        "name": "пропустить",
        "в": "запрос",
        "описание": "количество элементов, которые нужно пропустить",
        "требуется": правда,
        "тип": "целое число",
        "формат": "int32"
      },
      "limitParam": {
        "name": "limit",
        "в": "запрос",
        "description": "максимальное количество возвращаемых записей",
        "требуется": правда,
        "тип": "целое число",
        "формат": "int32"
      }
    } 
     skipParam:
      имя: пропустить
      в: запрос
      описание: количество элементов, которые нужно пропустить
      требуется: правда
      тип: целое число
      формат: int32
    limitParam:
      имя: предел
      в: запрос
      описание: максимальное количество возвращаемых записей
      требуется: правда
      тип: целое число
      формат: int32 
    Ответы Определения Объект

    Объект для хранения ответов для повторного использования во всех операциях.Определения ответов можно ссылаться на те, которые определены здесь.

    Это не , а не определяет глобальные операционные ответы.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} Объект ответа Определение одиночного ответа, сопоставляющее «имя» с ответом, который он определяет.
    Ответы Определения Пример объекта
     {
      "Не обнаружена": {
        "description": "Объект не найден."
      },
      "IllegalInput": {
      "description": "Незаконный ввод для работы".
      },
      "Общая ошибка": {
      "description": "Общая ошибка",
      "schema": {
      "$ ref": "# / definitions / GeneralError"
      }
      }
    } 
     NotFound:
      описание: Сущность не найдена.
    IllegalInput:
      описание: Незаконный ввод в эксплуатацию.
    Общая ошибка:
      описание: Общая ошибка
      схема:
        $ ref: '# / definitions / GeneralError' 
    Объект определений безопасности

    Объявление схем безопасности, доступных для использования в спецификации.Это не навязывает схемы безопасности для операций, а служит только для предоставления соответствующих деталей для каждой схемы.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} Объект схемы безопасности Определение единой схемы безопасности, отображение «имени» на схему, которую оно определяет.
    Пример объекта "Определения безопасности"
     {
      "api_key": {
        "тип": "apiKey",
        "name": "api_key",
        "в": "заголовок"
      },
      "petstore_auth": {
        "тип": "oauth3",
        "authorizationUrl": "http: // чванство.io / api / oauth / dialog ",
        "поток": "неявный",
        "scopes": {
          "write: pets": "изменить домашних животных в вашем аккаунте",
          "читать: домашние животные": "читать своих питомцев"
        }
      }
    } 
     api_key:
      тип: apiKey
      имя: api_key
      в: заголовок
    petstore_auth:
      тип: oauth3
      authorizationUrl: http://swagger.io/api/oauth/dialog
      поток: неявный
      объемы:
        напишите: pets: измените домашних животных в своем аккаунте
        читать: домашние животные: читать своих питомцев 
    Объект схемы безопасности

    Позволяет определять схему безопасности, которая может использоваться операциями.Поддерживаемые схемы: базовая аутентификация, ключ API (в виде заголовка или параметра запроса) и общие потоки OAuth3 (неявные, пароль, приложение и код доступа).

    Фиксированные поля
    Имя поля Тип Срок действия Описание
    тип строка Любые Обязательно. Тип схемы безопасности. Допустимые значения: "basic" , "apiKey" или "oauth3" .
    описание строка Любые Краткое описание схемы безопасности.
    наименование строка apiKey Обязательно. Имя заголовка или параметра запроса, который будет использоваться.
    дюйм строка apiKey Обязательно Расположение ключа API.Допустимые значения: «запрос» или «заголовок» .
    поток строка oauth3 Обязательно. Поток, используемый схемой безопасности OAuth3. Допустимые значения: «неявный» , «пароль» , «приложение» или «код доступа» .
    authorizationUrl строка oauth3 ( "неявный" , "accessCode" ) Обязательно. URL-адрес авторизации, который будет использоваться для этого потока. Это ДОЛЖНО быть в форме URL.
    tokenUrl строка oauth3 ( «пароль» , «приложение» , «код доступа» ) Обязательно. URL-адрес токена, который будет использоваться для этого потока. Это ДОЛЖНО быть в форме URL.
    прицелов Прицелы Объект oauth3 Обязательно.х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта схемы безопасности
    Образец базовой аутентификации
    Пример ключа API
     {
      "тип": "apiKey",
      "name": "api_key",
      "в": "заголовок"
    } 
     тип: apiKey
    имя: api_key
    в: заголовок 
    Пример неявного OAuth3
     {
      "тип": "oauth3",
      "authorizationUrl": "http: // чванство.io / api / oauth / dialog ",
      "поток": "неявный",
      "scopes": {
        "write: pets": "изменить домашних животных в вашем аккаунте",
        "читать: домашние животные": "читать своих питомцев"
      }
    } 
     тип: oauth3
    authorizationUrl: http://swagger.io/api/oauth/dialog
    поток: неявный
    объемы:
      напишите: pets: измените домашних животных в своем аккаунте
      читать: домашние животные: читать своих питомцев 
    Прицелы Объект

    Перечисляет доступные области для схемы безопасности OAuth3.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} строка Сопоставляет имя области с ее кратким описанием (как значение свойства).х- Любые Разрешает расширения схемы Swagger. Имя поля ДОЛЖНО начинаться с x- , например, x-internal-id . Значение может быть null , примитивом, массивом или объектом. См. Дополнительные сведения в разделе «Расширения поставщика».
    Пример объекта области
     {
      "write: pets": "изменить домашних животных в вашем аккаунте",
      "читать: домашние животные": "читать своих питомцев"
    } 
     написать: pets: изменить pets в вашем аккаунте
    читать: домашние животные: читать своих питомцев 
    Объект требований безопасности

    Перечисляет необходимые схемы безопасности для выполнения этой операции.В объекте может быть объявлено несколько схем безопасности, которые все являются обязательными (то есть между схемами существует логическое И).

    Имя, используемое для каждого свойства, ДОЛЖНО соответствовать схеме безопасности, объявленной в определениях безопасности.

    Узорчатые поля
    Схема поля Тип Описание
    {имя} [ строка ] Каждое имя должно соответствовать схеме безопасности, которая объявлена ​​в определениях безопасности.Если схема безопасности имеет тип «oauth3» , то значение представляет собой список имен областей, необходимых для выполнения. Для других типов схем безопасности массив ДОЛЖЕН быть пустым.
    Примеры объектов требований безопасности
    Требование безопасности без OAuth3
    Требование безопасности OAuth3
     {
      "petstore_auth": [
        "написать: домашние животные",
        "читать: домашние животные"
      ]
    } 
     petstore_auth:
    - напишите: домашние животные
    - читать: домашние животные 

    Расширения спецификаций

    Хотя спецификация Swagger пытается учесть большинство вариантов использования, в определенные моменты могут быть добавлены дополнительные данные для расширения спецификации.

    Свойства расширений всегда имеют префикс "x-" и могут иметь любое допустимое значение формата JSON.

    Расширения могут поддерживаться или не поддерживаться доступными инструментами, но они также могут быть расширены для добавления запрошенной поддержки (если инструменты являются внутренними или имеют открытый исходный код).

    Фильтрация безопасности

    Некоторые объекты в спецификации Swagger могут быть объявлены и оставаться пустыми или полностью удалены, даже если они по сути являются ядром документации API.

    Причина в том, чтобы позволить дополнительный уровень контроля доступа к самой документации. Хотя это и не является частью самой спецификации, некоторые библиотеки могут разрешить доступ к частям документации на основе некоторой формы аутентификации / авторизации.

    Два примера для этого:

    1. Объект Paths может быть пустым. Это может показаться нелогичным, но это может сказать зрителю, что он попал в нужное место, но не может получить доступ к какой-либо документации.У них по-прежнему будет доступ к информационному объекту, который может содержать дополнительную информацию об аутентификации.
    2. Объект Path Item может быть пустым. В этом случае зритель будет знать, что путь существует, но не сможет увидеть какие-либо его операции или параметры. Это отличается от сокрытия самого пути от объекта Paths, чтобы пользователь не узнал о его существовании. Это позволяет поставщику документации более точно контролировать то, что может видеть зритель.

    амазонка.aws.aws_s3 - управлять объектами в S3. - Документация Ansible

    Параметр Выбор / значения по умолчанию Комментарии
    aws_access_key

    нить

    Ключ доступа AWS.Если не задано, используется значение переменной среды AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

    Если установлен профиль , этот параметр игнорируется.

    Одновременная передача параметров aws_access_key и профиля устарела, и после 01.06.2022 эти параметры станут взаимоисключающими.


    псевдонимы: ec2_access_key, access_key

    aws_ca_bundle

    дорожка

    Расположение пакета CA для использования при проверке сертификатов SSL.

    Используется только для модулей на основе boto3.

    Примечание. Пакет CA считывается на стороне «модуля» и может потребоваться явное копирование из контроллера, если он не запускается локально.

    aws_config

    Словарь

    Словарь для изменения конфигурации ботокора.

    aws_secret_key

    нить

    Секретный ключ AWS.Если не задано, используется значение переменной среды AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

    Если установлен профиль , этот параметр игнорируется.

    Одновременная передача параметров aws_secret_key и profile устарела, и после 01.06.2022 эти параметры станут взаимоисключающими.


    псевдонимы: ec2_secret_key, secret_key

    ведро

    нить / требуется

    Название ковша.

    содержание

    нить

    добавлено в 1.3.0 amazon.aws

    Содержимое, которое нужно ПОЛУЧИТЬ в объект.

    Значение параметра будет рассматриваться как строка и преобразовываться в UTF-8 перед отправкой на S3. Для отправки двоичных данных используйте вместо этого параметр content_base64 .

    Для операции PUT необходимо указать content , content_base64 или src . В противном случае игнорируется.

    content_base64

    нить

    добавлен в 1.3.0 из amazon.aws

    Двоичные данные в кодировке base64 для вставки в объект.

    Используйте это, если вам нужно поместить необработанные двоичные данные и не забыть кодировать в base64.

    Для операции PUT необходимо указать content , content_base64 или src . В противном случае игнорируется.

    debug_botocore_endpoint_logs

    логический

    Используйте ботокору.регистратор конечных точек для анализа уникальных (а не общих) вызовов API "resource: action", сделанных во время задачи, с выводом набора для ключа resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода в общий список, созданный во время playbook. Также может использоваться переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

    цель

    дорожка

    Путь к файлу назначения при загрузке объекта / ключа с помощью операции GET.

    двойной стек

    логический

    Включает конечные точки Amazon S3 Dual-Stack, обеспечивая связь S3 с использованием как IPv4, так и IPv6.

    Требуется ботокор версии не ниже 1.4.45.

    ec2_url

    нить

    URL-адрес для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль будет использовать конечные точки EC2).Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной среды EC2_URL, если таковая имеется.


    псевдонимы: aws_endpoint_url, endpoint_url

    зашифровать

    логический

    В режиме PUT запрашивает шифрование на стороне сервера.

    encryption_kms_key_id

    нить

    Идентификатор ключа KMS для использования при шифровании объектов с помощью encrypting = aws: kms .Игнорируется, если шифрование не aws: kms .

    encryption_mode

    нить

      Выбор:
    • AES256

    • aws: кмс

    Какой режим шифрования использовать, если encrypt = true .

    истечение

    целое число

    По умолчанию:

    600

    Ограничение времени (в секундах) для URL-адреса, сгенерированного и возвращенного S3 / Walrus при выполнении операции mode = put или mode = geturl .


    псевдонимы: срок действия

    заголовков

    Словарь

    Пользовательские заголовки для операции PUT, как словарь ключ = значение и ключ = значение, ключ = значение .

    ignore_nonexistent_bucket

    логический

    Переопределяет первоначальный поиск в сегменте, если политики сегмента или iam являются ограничительными.Пример: у пользователя может быть разрешение GetObject, но не другие разрешения. В этом случае использование опции mode: get завершится ошибкой без указания ignore_nonexistent_bucket = true .

    маркер

    нить

    Задает ключ, с которого следует начать при использовании режима списка.Ключи объектов возвращаются в алфавитном порядке, начиная с ключа после маркера.

    max_keys

    целое число

    По умолчанию:

    1000

    Максимальное количество результатов, возвращаемых в режиме списка, установите это значение, если вы хотите получить меньше 1000 ключей по умолчанию.

    метаданные

    Словарь

    Метаданные для операции PUT в виде словаря ключ = значение и ключ = значение, ключ = значение .

    режим

    нить / требуется

      Выбор:
    • получить
    • пут
    • удалить
    • создать
    • geturl
    • getstr
    • дело
    • список

    Переключает поведение модуля между put (выгрузка), get (загрузка), geturl (возврат URL-адреса загрузки, Ansible 1.3+), getstr (загрузить объект как строку (1.3+)), list (ключи списка, Ansible 2.0+), create (bucket), delete (bucket) и delobj (удалить объект, Ansible 2.0+).

    объект

    нить

    Ключевое имя объекта внутри ведра.Может использоваться для создания «виртуальных каталогов», см. Примеры.

    перезаписать

    нить

    По умолчанию:

    «всегда»

    Принудительная перезапись либо локально в файловой системе, либо удаленно с помощью объекта / ключа.Используется с операциями PUT и GET.

    Должно быть логическим, всегда , никогда или другое .

    true то же самое, что всегда .

    ложно равно никогда .


    псевдонимы: force

    разрешение

    список / elements = строка

    По умолчанию:

    ["частный"]

    Этот параметр позволяет пользователю устанавливать постоянные разрешения для создаваемого объекта / сегмента.Можно установить следующие разрешения: частное , публичное чтение , публичное чтение-запись , аутентифицированное чтение для корзины или частное , публичное чтение , публичное чтение-запись , aws-exec-read , Authenticated-read , bucket-owner-read , bucket-owner-full-control для объекта. В виде списка можно указать несколько разрешений.

    префикс

    нить

    По умолчанию:

    ""

    Ограничивает ответ ключами, которые начинаются с указанного префикса для режима списка.

    профиль

    нить

    Использует бото-профиль.Работает только с boto> = 2.24.0.

    Использование профиля переопределит aws_access_key , aws_secret_key и security_token и поддержку их передачи одновременно с тем, что профиль устарел.

    aws_access_key , aws_secret_key и security_token будут взаимоисключающими с профилем после 2022-06-01.


    псевдонимы: aws_profile

    регион

    нить


    псевдонимы: aws_region, ec2_region

    попыток

    целое число

    По умолчанию:

    0

    При восстановимой ошибке, сколько раз повторять попытку, прежде чем произойдет сбой.


    псевдонимы: retry

    rgw

    логический

    Включить поддержку Ceph RGW S3.Эта опция требует явного URL-адреса через s3_url .

    s3_url

    нить

    Конечная точка URL

    S3 для использования с Ceph, Eucalyptus, fakes3 и т. Д.В противном случае предполагает AWS.


    псевдонимы: S3_URL

    security_token

    нить

    Маркер безопасности AWS STS.Если не задано, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

    Если установлен профиль , этот параметр игнорируется.

    Одновременная передача параметров security_token и профиля устарела, и после 01.06.2022 эти параметры станут взаимоисключающими.


    псевдонимы: aws_security_token, access_token

    src

    дорожка

    Путь к исходному файлу при выполнении операции PUT.

    Для операции PUT необходимо указать content , content_base64 или src . В противном случае игнорируется.

    validate_certs

    логический

    Если установлено значение «no», сертификаты SSL не будут проверяться для версий boto> = 2.

    Оставить комментарий

    Ваш адрес email не будет опубликован. Обязательные поля помечены *